Authentifizierung

API Navigation

Allgemeines: Grundlagen Authentifizierung Fehlerbehandlung Datenstruktur

Hauptmodelle: Kontakte Reservierungen

Sonstiges: Schlagwörter

Die Authentifizierung erfolgt grundsätzlich über einen API Schlüssel. Eine Authentifizierung mittels Nutzername und Passwort ist aktuell nicht vorgesehen. Neue API Schlüssel kann der Inhaber eines CentralPlanner Accounts in seinen Accounteinstellungen anlegen. Der API Schlüssel identifiziert den Nutzer und CentralPlanner Account dann eindeutig, es sind keine weiteren Daten wie zB. Accountname erforderlich.

Zur Authentifizierung kann der API Schlüssel als Header Token oder als HTTP Parameter übergeben werden.

Beispiel Request via Curl mit Authorisierung via Header Token

curl "https://centralplanner.net/api/contacts" -H 'Authorization: Token token="my-api-token"'

Beispiel Request via Curl mit Authorisierung via HTTP Parameter

curl https://centralplanner.net/api/contacts?apikey=my-api-token

Für eine gewisse Zeit wird die Session dann aufrecht gehalten, so dass keine weitere Authentifizierung nötig ist. Wenn die Session abgelaufen ist fragt der Server wieder nach den Zugangsdaten. Für die Nutzung der API müssen keine neuen Benutzer angemeldet werden.