API

Verwenden Sie die interaktive DocID^® API-Referenz für unterstützte Business Resources.

Die DocID^® Business API ist über eine interaktive Swagger-Oberfläche dokumentiert.

Das maschinenlesbare OpenAPI-Dokument ist verfügbar unter:

1https://docid.pro/api/openapi.json

API und OAuth im Vergleich

Verwenden Sie die OAuth-2.0-Endpoints zur Authentifizierung eines Website-Besuchers und zum Abrufen freigegebener Identity Information.

Verwenden Sie die Business API für die im OpenAPI-Dokument beschriebenen Management- und Application Resources. Authentication Requirements, Request Schemas, Responses und Error Codes sind für jede Operation in der interaktiven Referenz dokumentiert.

Sichere API-Nutzung

Rufen Sie privilegierte Operationen aus vertrauenswürdigem serverseitigem Code auf.
Verwenden Sie die für die aktuelle Umgebung vorgesehenen Credentials.
Validieren Sie jede Response und behandeln Sie Status Codes außerhalb des Erfolgsbereichs.
Protokollieren Sie keine Authorization Header oder sensiblen Response Data.
Verwenden Sie dokumentierte Identifiers, statt Resource Relationships abzuleiten.