...
| Angabe | Beschreibung | Beispiel |
|---|---|---|
| Basis-URL | Die Basis-URL definiert, unter welcher URL die Services verfügbar sind. | http://www.domain.com/daylight/ |
| Service-URL | Die verschiedenen daylight Service-Methoden sind in Gruppen zusammengefasst, so finden sich z.B. alle Event relevanten Methoden unter {Basis-URL}/EventService/. | http://www.domain.com/daylight/EventService |
| Methode | Pro Service steht eine Anzahl an Methoden zur Verfügung. Eine Übersicht kann der folgenden Seite entnommen werden. | http://www.domain.com/daylight/EventService/GetOccurrence?x=1 |
| Header Informationen | Nebst der vollständigen URL (Basis-URL, Service-URL und Methode) müssen drei HTTP Header bei jedem Aufruf gesetzt werden. | |
| api-key | Der API-Key wird jeweils kommuniziert, ohne diese Information wird der Service keine Antwort geben. Damit wird der Service rudimentär vor unbefugtem Zugriff geschützt. | 1234 |
| Accept | Der Accept Header muss auf application/json oder application/xml gesetzt werden. | application/json |
| Content-Type | Der Content-Type Header muss auf application/json oder application/xml gesetzt werden. | application/json |
...
| Use Case | Beschreibung | Dokumentation |
|---|---|---|
| Anmeldung erstellen | Beschreibt das erstellen einer Anmeldung | Anmeldung erstellen |
| Dokumente und Bilder laden | Dokumente und Bilder per Web API laden |