Alle Anfragen an die Optimaite API müssen mit einem API-Schlüssel authentifiziert werden. API-Schlüssel sind einem bestimmten Workspace zugeordnet und tragen eine Menge von Berechtigungen.

API-Schlüssel

API-Schlüssel erstellen

Navigieren Sie in Optimaite Law zu Workspace-Einstellungen > API-Schlüssel
Klicken Sie auf API-Schlüssel erstellen
Vergeben Sie einen aussagekräftigen Namen (z. B. „CRM-Integration“)
Wählen Sie die Scopes (Berechtigungen), die der Schlüssel benötigt
Klicken Sie auf Schlüssel generieren
Kopieren Sie den Schlüssel sofort -- er wird nur einmal angezeigt

API-Schlüssel sind Geheimnisse. Speichern Sie sie sicher (Umgebungsvariablen, Secret Manager) und committen Sie sie niemals in die Versionskontrolle. Wenn ein Schlüssel kompromittiert wurde, widerrufen Sie ihn umgehend.

Anfragen authentifizieren

Fügen Sie Ihren API-Schlüssel im Header Authorization als Bearer-Token ein:

Authorization: Bearer opt_live_abc123def456ghi789

Jede Anfrage muss diesen Header enthalten. Anfragen ohne gültigen Schlüssel erhalten eine 401 Unauthorized-Antwort.

Schlüssel-Präfixe

opt_live_ -- Live-Schlüssel (Produktion)
opt_test_ -- Test-Schlüssel (Sandbox-Daten)

Scopes

API-Schlüssel sind durch Scopes eingeschränkt, auf welche Ressourcen sie zugreifen dürfen. Beim Erstellen eines Schlüssels wählen Sie einen oder mehrere Scopes:

Scope	Beschreibung
`cases:read`	Akten-Daten lesen
`cases:write`	Akten erstellen und aktualisieren
`cases:delete`	Akten löschen
`parties:read`	Parteien-/Kontaktdaten lesen
`parties:write`	Parteien erstellen und aktualisieren
`parties:delete`	Parteien löschen
`documents:read`	Dokument-Metadaten lesen
`documents:write`	Dokumente hochladen und aktualisieren
`documents:delete`	Dokumente löschen
`deadlines:read`	Kalenderereignisse und Fristen lesen
`deadlines:write`	Fristen erstellen und aktualisieren
`calendar:read`	Kalenderereignisse und Terminplanung lesen
`calendar:write`	Ereignisse erstellen und Terminplanung verwalten
`invoices:read`	Rechnungsdaten lesen
`invoices:write`	Rechnungen erstellen und aktualisieren

Befolgen Sie das Prinzip der geringsten Berechtigung. Fordern Sie nur die Scopes an, die Ihre Integration tatsächlich benötigt. Sie können jederzeit mehrere API-Schlüssel mit unterschiedlichen Scopes für verschiedene Anwendungsfälle anlegen.

API-Schlüssel verwalten

Schlüssel auflisten

Navigieren Sie zu Workspace-Einstellungen > API-Schlüssel, um alle aktiven Schlüssel, ihre Scopes, das Datum der letzten Nutzung und das Erstellungsdatum zu sehen.

Schlüssel rotieren

So rotieren Sie einen Schlüssel ohne Ausfallzeit:

Erstellen Sie einen neuen API-Schlüssel mit denselben Scopes
Aktualisieren Sie Ihre Integration auf den neuen Schlüssel
Prüfen Sie, dass die Integration mit dem neuen Schlüssel funktioniert
Widerrufen Sie den alten Schlüssel

Schlüssel widerrufen

Klicken Sie auf der Seite API-Schlüssel neben einem Schlüssel auf Widerrufen. Der Widerruf ist sofort wirksam -- alle Anfragen mit diesem Schlüssel erhalten 401 Unauthorized.

Fehlerantworten

Status	Code	Bedeutung
401	`AUTH_INVALID_KEY`	API-Schlüssel fehlt, ist fehlerhaft oder wurde widerrufen
401	`AUTH_EXPIRED_KEY`	API-Schlüssel ist abgelaufen
403	`AUTH_INSUFFICIENT_SCOPE`	Schlüssel hat nicht den erforderlichen Scope für diesen Endpunkt
403	`AUTH_TENANT_INACTIVE`	Workspace-Abonnement ist nicht aktiv

Nächste Schritte

Rate Limits -- Request-Kontingente verstehen
Akten-API -- Erste Anfragen senden

Authentifizierung