Authentifizierung
Die Paperarchive API nutzt Bearer-Token-Authentifizierung mit API-Schlüsseln. Jede Anfrage muss deinen API-Schlüssel im Authorization-Header enthalten.
Einen API-Schlüssel erstellen
Erstelle und verwalte API-Schlüssel in der Paperarchive-App unter Einstellungen > API-Schlüssel. Jeder Schlüssel kann auf bestimmte Berechtigungen und Spaces beschränkt werden.
Deinen API-Schlüssel verwenden
Füge den Schlüssel als Bearer-Token im Authorization-Header ein:
Authorization: Bearer pa_live_abc123def456...Schlüsselformat
API-Schlüssel verwenden das Präfix pa_live_ gefolgt von einer zufälligen Zeichenkette. Der vollständige Schlüssel wird nur einmal bei der Erstellung angezeigt - speichere ihn sicher ab.
Berechtigungen (Scopes)
Jedem API-Schlüssel werden Scopes zugewiesen, die den Zugriff steuern. Verfügbare Scopes:
| Scope | Beschreibung |
|---|---|
documents:read | Dokumente auflisten und abrufen |
documents:write | Dokumente erstellen und löschen |
search | Dokumentenübergreifend suchen |
spaces:read | Spaces auflisten und abrufen |
categories:read | Kategorien auflisten |
categories:write | Kategorien erstellen und löschen |
tags:read | Tags auflisten |
tags:write | Tags erstellen und löschen |
senders:read | Absender auflisten |
senders:write | Absender erstellen und löschen |
Space-Einschränkungen
API-Schlüssel können optional auf bestimmte Spaces eingeschränkt werden. In diesem Fall kann der Schlüssel nur auf Dokumente, Kategorien, Tags und Absender innerhalb dieser Spaces zugreifen.
Sicherheitsempfehlungen
- Verwende nur die minimal nötigen Scopes für deine Integration
- Beschränke Schlüssel nach Möglichkeit auf bestimmte Spaces
- Rotiere Schlüssel regelmäßig
- Gib Schlüssel niemals in clientseitigem Code oder öffentlichen Repositories preis
- Widerrufe kompromittierte Schlüssel sofort