Basis-URL
Adresse unter der das System verfügbar ist.
Zum Beispiel www.example.com
Installations-Kontext
Beispiel: www.example.com/mglv
Der Installationscontext ist der Teil der URL, der in der Regel direkt auf den Host (www.mitglieder.example.com) folgt. Im Beispiel oben "mglv"
Service URL (API)
Unter der Service URL stellt das System den Zugang zur API zur Verfügung. Die Service URL setzt sich aus der Basis-URL, dem Installations-kontext und dem API-Pfad zusammen.
Beispiel API-Pfad:
/rest/api/1/2/service
Der Api-Pfad setzt sich wie folgt zusammen:
API-Basis: /API-BASIS/API_MAJOR_VERSION/API_MINOR_VERSION/SERVICE/serviceCall
Die Api-Basis ist fest: /rest/api
API_MAJOR_VERSION: 1 | 2 | 3,..(Ganzzahl)
API_MINOR_VERSION: 1 | 2 | 3,..(Ganzzahl)
Die aktuell unterstützten Major und Minor API-Versionsnummern entnehmen sie bitte den für das Installierte System definierten Release-Informationen. Grundsätzlich ist eine Installation in der Regel in der Lage alle Minor-API Versionen eines Major-API-Releases gleichzeitig zu unterstützen. Ob und in wie weit verschiedene Major-API-Releases von der Installation unterstützt werden ist installationsabhängig.
SERVICE ist fest: service
serviceCall: der Service-Call ist nicht fest und entspricht dem Aufruf des gewünschten Services. Der Aufruf, um die Liste der möglichen Mitglieder-Stati zu bekommen wäre beispielsweise:
Schema: http oder https
Method: PUT, GET, POST, DELETE
Details zur Benutzung der API finden sich in API.