WebServices / API
Zugriff auf den cocktailberater
Der cocktailberater bietet viele offene Schnittstellen an, welche allerdings noch nicht stabil sind. Wollen Sie also dauerhaft eine Schnittstelle verwenden, geben Sie uns bitte Bescheid, damit wir die Schnittstelle auch in Zukunft garantieren können. Wir richten auch gern neue Schnittstellen ein, wenn Sie eine benötigen. Mit den angebotenen Schnittstellen (APIs) können Rezeptinformationen auch von anderen Anwendungen genutzt werden.
REST-Schnittstelle
Die Basis-URL für die REST-Schnittstelle ist http://www.cocktailberater.de/website.
Dahinter kommt das Themengebiet (die Ressource) auf Englisch, wie zum
Beispiel /recipe, /cocktail, /ingredient,
/ingredient-category, /manufacturer, /product,
/comment, /tag, /glass oder /rating.
Nun kann das gewünschte Ausgabeformat mit ?format=
angegeben werden. Es stehen zur Verfügung: html, xml,
json, pdf, rdf, rss,
atom, htmlexport, image und mobile.
Wenn der Zugriff nur auf ein bestimmtes Objekt mit einer ID (Zahl oder
eindeutiger Name) benötigt wird, kann die ID auch hinter das
Themengebiet geschrieben werden, zum Beispiel /4711.
Ein vollständiges Beispiel um also alle Rezepte als XML angezeigt zu
bekommen wäre: http://www.cocktailberater.de/website/recipe/?format=xml
oder um alle Kommentare als Atom-Feed zu bekommen: http://www.cocktailberater.de/website/comment?format=atom.
Die folgende Tabelle listet alle bisher öffentlichen REST-Schnittstellen auf. Die Formate sind jeweils mit einem Beispiel verlinkt.
| Ressource | HTTP-Methode | Formate |
|---|---|---|
| cocktail | GET | xml, json, atom, rss, html, mobile |
| cocktail | GET mit ID | html, mobile |
| comment | GET | atom, rss |
| ingredient | GET | html, mobile |
| ingredient | GET mit ID | html, mobile |
| ingredient-category | GET | html, mobile |
| ingredient-category | GET mit ID | html, mobile |
| manufacturer | GET | html, mobile |
| manufacturer | GET mit ID | html, mobile |
| product | GET | html, mobile |
| product | GET mit ID | html, mobile |
| rating | GET | atom, rss |
| recipe | GET | xml, json, atom, rss, html, htmlexport, mobile, pdf (Cocktailkarte) |
| recipe | GET mit ID | xml, json, atom, rss, rdf, html, mobile, pdf, image |
| glass | GET mit ID | image |
| tag | GET | atom, rss |
Die generische URI zur Ressource lautet: http://www.cocktailberater.de/website/[:Ressource:]/
[:ID:]?format[:Format:]. Es ist bisher nicht möglich die
HTTP-Methoden POST, PUT oder DELETE etc. auf die Ressourcen anzuwenden.
Web-Service Schnittstelle (WSDL)
Der cocktailberater bietet auch eine WSDL-Schnittstelle an. Hiermit können Rezepte nach ID, Name, Zutat, Tag und Schwierigkeitsgrad gesucht werden.