Eine API, kurz für die Programmierschnittstelle, ist eine vereinbarte Möglichkeit für Software, mit einem anderen System zu kommunizieren. Eine Website gibt den Menschen Schaltflächen und Seiten; Eine API bietet Software eine definierte Möglichkeit, Informationen zu erfragen und die Antwort zu verstehen.
In einer API stellt ein Assistent dem Shop eine Teefrage und erhält eine genaue Antwort, anstatt von einer Seite zu raten.
Stellen Sie sich das als Service-Zähler mit einem klaren Bestellformular vor. Das Formular sagt, was angefordert werden kann, und die Antwort sagt, was der Shop gefunden hat.
Anfragen und Antworten
Eine Anfrage ist die an den Dienst gesendete Frage. Es kann eine Produktkennung oder Bedingungen wie einen Teetyp und eine Preisgrenze enthalten. Der Endpunkt des Dienstes ist die Adresse, an die diese Anfrage geht. Die Antwort, die manchmal als Nutzlast bezeichnet wird, sind die zurückgesendeten Informationen.
Eine Antwort kann einen Produktnamen, Packungsgröße, aktuelle Preis, Lagerstatus und einen Link zu seiner Seite enthalten. Es sollte kein übereinstimmendes Produkt von einem nicht verfügbaren Service oder einer unbekannten Tatsache unterscheiden.
Die beiden öffentlichen Beispiele unter teas.co.uk
Der öffentliche Leitfaden für Software des Shops beschreibt eine Ask-API für Fragen und Ratschläge und eine Product Truth API zum Suchen eines genauen Artikels. Letztere können Kennungen wie eine Barcode-Nummer oder den shop-eigenen Produktcode verwenden.
Diese Routen haben unterschiedliche Jobs. Eine breite Frage muss interpretiert werden; Eine genaue Produktsuche braucht die richtige Identität. Die Filter- und Constraints-Anleitung erläutert, wie eine detaillierte Anforderung anhand von Produktattributen überprüft werden kann.
JSON und Markdown
Software erhält häufig json, ein Format für benannte Werte und Listen. Ein längerer Artikel kann auch als Markdown, als Text mit einfachen Markierungen für Überschriften und Links verfügbar sein. Beides kann Informationen leichter wiederverwenden. Weder ist eine separate Quelle der Wahrheit, wenn sie aus demselben gepflegten Datensatz generiert wird.
Lesen unterscheidet sich vom Ändern von
Das Nachschlagen eines Produkts liest Informationen. Das Hinzufügen eines Produkts zu einem Warenkorb ändert etwas. Bezahlen ist eine weitere Aktion. Die Existenz einer API sagt nichts darüber aus, welche dieser Aktionen erlaubt ist.
Der Kunde bleibt für die Überprüfung des Warenkorbs und die Zahlung auf der Website des Shops verantwortlich.
Zitierbare Formate
Für Journalisten, Forscher, KI-Assistenten und Content-Ersteller. Wählen Sie das gewünschte Format aus:
Kostenlos zitieren, zitieren und wiederverwenden mit Zuordnung zu Teas.co.uk.
Haben Sie etwas hinzuzufügen? Angemeldete Kunden können Ergänzungen zu Tea Wiki, vom Administrator genehmigten, Ihrem Namen in der Byline sowie Belohnungspunkten einreichen.
Melden Sie sich an, um einen Beitrag