![]() |
|||||||||||||||||||||||||||||||||
Hallo Gast! [anmelden] | Lebensmittelsuche | Lebensmittel eintragen | Neueste Einträge | ||||||||||||||||||||||||||||||||
API-DokumentationLaktonaut stellt eine Programmierschnittstelle (API) zur Verfügung, über die fremde Anwendungen Informationen aus der Lebensmitteldatenbank beziehen können. Derzeit ist nur die Abfrage von Informationen zu einem Artikel mit einer gegebenen GTIN (auch EAN oder "Barcode-Nummer" genannt) möglich. Die Nutzung der API unterliegt unseren Nutzungsbedingungen (siehe dort insbesondere § 8). Sie bedarf unserer schriftlichen Einwilligung. Eine gewisse Anzahl von Anfragen zu Testzwecken kann grundsätzlich jeder mit Hilfe des Die folgende Dokumentation richtet sich direkt an Anwendungsentwickler. Vorausgesetzt wird ein prinzipielles Verständnis von HTTP-Anfragen und XML-Daten. KapitelAnfrage des ClientsUm eine Anfrage an den Server zu richten, sendet der Client einen HTTP-GET-Request an http://www.laktonaut.de/api.php?action=query>in= gtin&key= key
Beispiel: ParametergtinGTIN (EAN) des gesuchten Artikels Eine gültige GTIN ist ein String aus zumeist 8 oder 13, manchmal auch 12 oder 14 Ziffern. Formal akzeptiert werden allerdings Strings beliebiger Länge. Alle nichtnumerischen Zeichen (beispielsweise Trennzeichen) werden dabei ignoriert. Führende Nullen sind jedoch von Bedeutung – eine GTIN ist ein String und keine Zahl, Die Angabe wird unabhängig von ihrer Länge als vollständige GTIN interpretiert. Eine Suche nach Teil-GTINs ist derzeit nicht möglich. keyPersönlicher Zugangsschlüssel des Clients; wird auf Anfrage zugeteilt Zu Testzwecken kann der Schlüssel Antwort des ServersDie Antwort des Servers ist vom Client zunächst auf ihren HTTP-Status-Code hin zu prüfen. Der Server verwendet diese Codes semantisch korrekt gemäß RFC 2616. Bei einem HTTP-Status-Code von
Der Zeichensatz für alle Strings ist UTF-8. Die folgenden fünf Zeichen werden, wie in XML üblich, als Entities kodiert:
Bei zukünftigen Änderungen und Erweiterungen der API wird volle Abwärtskompatibilität angestrebt, so dass auch Clients, die die Aktualisierungen noch nicht kennen, weiterhin funktionieren. Dies setzt eine gewisse Flexibilität des Clients voraus; er sollte seinerseits folgende Punkte beachten:
Subelemente von <laktonaut>
Die Subelemente statusStatuscode der Antwort als numerischer String (signed integer)
Werte > Der Wert Falls eine ungültige oder nicht vergebene GTIN übergeben wurde, wird kein Fehlercode zurückgegeben, sondern schlicht Beispiel: messageVom Menschen lesbare Mitteilung des Servers Das Element enthält eine Erfolgs- bzw. Fehlermeldung, die rein informativen Zwecken (z. B. für die Fehlersuche) dient und keinesfalls zur automatischen Statusprüfung verwendet werden sollte, da sie variieren kann. Beispiel: itemEnthält die Daten zu den gefundenen Artikeln Pro gefundenem Artikel wird genau ein Subelemente von <item>
Alle Subelemente von idLaktonaut-interne ID des Artikels als numerischer String (unsigned integer) Beispiel: gtinGTIN (EAN) des Artikels als String Die GTIN besteht in der Regel aus 8, 12, 13 oder 14 Ziffern ohne Trennzeichen. Der String ist nicht numerisch zu interpretieren – führende Nullen sind beizubehalten. Beispiel: nameName des Artikels Beispiel: genericGenerische Bezeichnung (Gattungsname) des Artikels Beispiel: categoryName der Kategorie des Artikels Das Beispiel: lactoseLaktosegehalt des Artikels als String
Andere Werte als Beispiel: linkLink zur Laktonaut-Beschreibungsseite des Artikels als vollständige URL Dieser Link ist als Verweis zur Quelle zu verwenden. Beispiel: Hinweis: Der Link ist auch dann noch gültig, wenn sich die im Dateinamen enthalten Informationen über Laktosegehalt und Produktnamen inzwischen geändert haben sollten. Wichtig ist allein die ID. Es wird jedoch darum gebeten, die URL nicht zu verändern und nur im Notfall den Kurzlink zu verwenden: shortlinkKurzlink zur Laktonaut-Beschreibungsseite des Artikels als vollständige URL Dieser Kurzlink sollte nur dann als Verweis zur Quelle verwendet werden, wenn Platzgründe dazu zwingen. Der im Beispiel: timestampZeitpunkt der letzten Änderung des Eintrags als Unix-Timestamp (numerischer String, unsigned integer) Beispiel: BeispielAnfrageAntwort
BilderMit der Zuweisung eines eigenen Schlüssels erhält der API-Nutzer die Erlaubnis, die folgenden Bilder im Kontext der API-Nutzung zu verwenden. Eine unerlaubte Verwendung ist untersagt. Wir bitten berechtigte Nutzer darum, die Bilder herunterzuladen und gegebenenfalls in der Größe anzupassen. Eine Direktverlinkung ist nicht erwünscht. |
|||||||||||||||||||||||||||||||||
![]() ![]() ![]() ![]() |
Gesundheitshinweis | Nutzungsbedingungen | Presse | Partner | API | Impressum / Kontakt |