ENSelbst hosten

Service-Schlüssel und Claims

Für Skripte und Drittsysteme verwenden Sie Service-API-Schlüssel statt Browser-Sessions. Jeder Schlüssel ist an einen Benutzer gebunden und trägt Berechtigungen (ABAC).

Schlüssel anlegen

  • Setzen Sie DOCUVATE_SERVICE_API_KEYS in .env als JSON-Array mit keyId, secret, tenantUserId und claims.
  • Starten Sie die API neu, damit die Schlüssel geladen werden.
  • Senden Sie den Secret-Wert im Header Authorization: Bearer <secret> oder X-Docuvate-Api-Key.

Claims (Berechtigungen)

Claims beschreiben, welche Aktionen der Schlüssel ausführen darf (z. B. Dokumente lesen, Labels verwalten). Die genaue Struktur entspricht dem OpenAPI-Vertrag und der SDK-Dokumentation.

Prüfen Sie in der SDK-Anleitung ein vollständiges Beispiel und testen Sie mit Ihrer Instanz unter GET /v1/openapi.json.

Sicherheit

  • Behandeln Sie Secrets wie Passwörter: nicht in Git committen, Rotation planen.
  • Vergeben Sie pro Integration einen eigenen Schlüssel mit minimalen Claims.
  • Produktions-URLs und TLS liegen in Ihrer Verantwortung (Reverse Proxy, Zertifikate).