Grundlagen

RESTful Webservice

Die billomat[API] ist als sogenannter RESTful Webservice angelegt, bei dem jede Ressource über eine eindeutige URI angesprochen wird.
Welche Opertationen mit den Ressourcen durchgeführt werden, wird mittels der HTTP-Verben angegeben:

– GET: Ressourcen lesen
– POST: Ressourcen erstellen
– PUT: Ressourcen bearbeiten
– DELETE: Ressourcen löschen
– HEAD: Nur Header-Daten lesen

Allgemeine Service-URL

https://{billomatID}.billomat.net/api/{ressource}[/{id}][/{methode}]
Parameter
Bedeutung
{billomatID}
Die billomatID des Accounts
{ressource}
Die Ressource, auf die zugegriffen werden soll
{id}
ID der konkreten Ressource
{methode}
Methode der allgemeinen oder konkreten Ressource
Datenformate
Billomat versteht für schreibende Requests die Formate XML und JSON. Folgende Punkte sollten dabei beachtet werden:
– Alle Requests sollten UTF-8-kodiert sein
– Boolsche Werte sind entweder 1 (true) oder 0 (false)
– Je nach gewünschtem Format bei den schreibenden Requests muss der entsprechende Content-Type im HTTP-Header gesetzt werden (application/xml oder application/json)
Responses können generell sowohl im XML-, als auch im JSON-Format erfolgen. Für spezielle Ressourcen sind auch weitere Formate mögliche (z.B. PDF).
Welches Format man als Response auf einen Request bekommen möchte, legt man über den GET-Parameter format fest (Standard-Format ist XML):
?format=[xml|json]
Alternativ kann das Format auch über einen HTTP-Header bestimmt werden:
Accept: application/json
JSONP
JSONP wird ebenfalls unterstützt. Dafür muss der Parameter jsonp angegeben werden, welcher optional den Namen der Callback-Funktion enthält. Die Standard-Callback-Funktion lautet callback.
?format=json&jsonp[=callback]
Damit ändert sich der zurückgegebene Content-Type in application/javascript.