Schlüssel erstellen
- Öffnen Sie Einstellungen, dann API-Schlüssel, und wählen Sie Schlüssel erstellen.
- Benennen Sie ihn nach dem verwendenden System. Wählen Sie einen Berechtigungsumfang und optional ein Ablaufdatum.
- Kopieren Sie den Schlüssel jetzt und speichern Sie ihn im Geheimnisspeicher Ihres Systems.
Important: Der vollständige Schlüssel wird einmal angezeigt. Bei Verlust widerrufen Sie ihn und erstellen einen neuen.
| Berechtigungsumfang | Handelt als |
|---|---|
| Nur lesen | Ein Betrachter. Kann alles lesen, was ein Betrachter lesen darf. |
| Lesen und schreiben | Höchstens ein Manager. Kann erstellen und ändern, was ein Manager darf. |
Verwendung
Senden Sie den Schlüssel bei jeder Anfrage an die App-API im Authorization-Header:
Authorization: Bearer ehk_...
- Ein Schlüssel gilt nur für seine eigene Organisation und innerhalb seines Berechtigungsumfangs.
- Mit einem Schlüssel ist kein CSRF-Header erforderlich.
- Ein Schlüssel kann keine weiteren Schlüssel erstellen oder verwalten.
- Anfragen mit einem Schlüssel werden im Prüfprotokoll unter dem API-Schlüssel erfasst.
Widerrufen
Wählen Sie bei einem Schlüssel Widerrufen. Er funktioniert sofort nicht mehr; verwendende Systeme erhalten 401-Fehler. Ein Schlüssel endet auch, wenn sein Ersteller die Organisation verlässt. Die Liste zeigt die letzte Verwendung jedes Schlüssels.
Tip: Geben Sie jeder Integration nach Möglichkeit einen eigenen Schlüssel mit Lesezugriff. Wird einer offengelegt, widerrufen Sie nur diesen.
Fordern Sie die API-Beschreibung für Ihre Entwickler über das Kontaktformular an.