#S0006 - Authentifizierung an der Rest-API

Die meisten API-Funktionen erfordern eine gültige Authentifizierung. Die Authentifizierung findet mittels HTTP Basic Authentication unter Verwendung des jeweiligen DOCBOX®-Benutzernamens und -Passworts statt, unter dessen Konto die API-Funktion ausgeführt werden soll.

Aus Sicherheitsgründen sollte der Zugriff immer über eine mit HTTPS abgesicherte Verbindung erfolgen, damit die Übertragung der Zugangsdaten verschlüsselt.

Ob eine API-Funktion eine Authentifizierung erfordert, ist der jeweiligen Funktions-Spezifikation zu entnehmen.

Beispiel bei Inhouse:

GET /docbox.webapp/api/inbox/list HTTP/1.1 
Authorization: Basic VXNlcjpQYXNz 
API-Key: dUdQBLnAZQ-4NwniKonV-wLkEyzsu4-OCxPGHZlZ 

Nutzung der API in der Cloud 

Wenn die API für eine DOCBOX® Cloud-Datenbank genutzt werden soll, muss bei jedem Request die entsprechende Cloud-ID übermittelt werden, um den Request der richtigen Cloud-Datenbank zuordnen zu können. 

Dies erfolgt durch das Setzen eines Header-Parameters mit Namen „Cloud-ID“, der als Wert die entsprechende Cloud-ID wie z.B. „9000-0123-4567-8900“ angibt. 

Beispiel bei Cloud:

GET /docbox.webapp/api/inbox/list HTTP/1.1
Authorization: Basic VXNlcjpQYXNz
Cloud-ID: 9000-0123-4567-8900
API-Key: dUdQBLnAZQ-4NwniKonV-wLkEyzsu4-OCxPGHZlZ

Dieser Header-Parameter muss für die Kommunikation mit einer Cloud-Datenbank immer gesetzt werden, auch wenn bei der jeweiligen Spezifikation einer API-Funktion angegeben ist, dass diese Funktion keine Header-Parameter benötigt. Bei der Funktions-Spezifikation sind nur diejenigen Header-Parameter genannt, die zusätzlich und spezifisch für diese Funktion erforderlich sind.