Authentifizierung¶
Alle Zugriffe auf die calServer REST-API erfordern eine Authentifizierung. Die Anmeldedaten werden als HTTP-Header mit jedem Request uebermittelt.
Erforderliche Header¶
| Header | Beschreibung |
|---|---|
HTTP_X_REST_USERNAME |
Benutzername des API-Benutzers |
HTTP_X_REST_PASSWORD |
Passwort des API-Benutzers |
HTTP_X_REST_API_KEY |
API-Schluessel (im Benutzerprofil generiert) |
Alle drei Header muessen in jeder Anfrage vorhanden sein. Fehlt einer der Header oder sind die Werte ungueltig, antwortet die API mit einem Authentifizierungsfehler.
API-Schluessel erstellen¶
- Melden Sie sich in calServer an
- Oeffnen Sie Ihr Benutzerprofil
- Navigieren Sie zum Bereich API-Schluessel
- Erzeugen Sie einen neuen Schluessel
Der API-Schluessel wird in der Tabelle FrontendUserKey gespeichert und ist dem jeweiligen Benutzerkonto zugeordnet.
Beispielanfrage¶
curl -X GET "https://ihre-instanz.example.com/api/inventory" \
-H "HTTP_X_REST_USERNAME: IhrBenutzername" \
-H "HTTP_X_REST_PASSWORD: IhrPasswort" \
-H "HTTP_X_REST_API_KEY: IhrAPIKey"
Berechtigungen¶
Der API-Zugriff unterliegt denselben Berechtigungen wie die Weboberflaeche. Ein API-Benutzer kann nur auf Daten zugreifen, fuer die seine Rolle die entsprechenden Operationen vorsieht. Die Rechteverwaltung erfolgt ueber das RBAC-System (siehe Sicherheitsrichtlinien).
Fehlercodes¶
| HTTP-Status | Bedeutung |
|---|---|
401 Unauthorized |
Fehlende oder ungueltige Anmeldedaten |
403 Forbidden |
Authentifizierung erfolgreich, aber fehlende Berechtigung |
404 Not Found |
Angeforderter Endpunkt oder Datensatz existiert nicht |
500 Internal Server Error |
Serverfehler -- pruefen Sie die Anwendungslogs |
Hinweise¶
- Uebertragen Sie Anmeldedaten ausschliesslich ueber HTTPS
- API-Schluessel koennen jederzeit im Benutzerprofil widerrufen und neu erzeugt werden
- Fuer automatisierte Systeme empfiehlt sich ein dediziertes Benutzerkonto mit eingeschraenkter Rolle