API Tokens

Mit API-Token kannst du programmatisch auf Papermerge-Funktionen zugreifen — über Skripte, Tools oder andere Anwendungen. Damit eine externe Anwendung Zugriff auf Papermerge erhält, musst du ihr zunächst ein von Papermerge ausgestelltes API-Token bereitstellen.

API-Token erstellen

So erstellst du ein API-Token:

Klicke oben rechts in der Web-Oberfläche auf das Benutzersymbol.
Wähle API-Token und klicke dann auf Token erstellen.
Gib dem Token einen Namen (z. B. „Für mein Skript”) und lege fest, wie viele Tage es gültig sein soll.

Nach der Erstellung zeigt dir der Dialog Token erstellt das Token im Klartext an. Kopiere das Token und bewahre es an einem sicheren Ort auf.

API-Token verwenden

Um ein API-Token zu verwenden, fügst du einen Authorization-Header mit dem Wert Bearer <dein Token> hinzu. Zum Beispiel:

Authorization: Bearer pm_MAxxThisxxxisxxxxExamplexxxTokenxxxt7I

Die REST-API-Dokumentation findest du im Benutzermenü (oben rechts in der Web-Oberfläche) unter REST API.

API-Server

Für private Konten ist der API-Server https://app.papermerge.com.
Für Team-Konten ist der API-Server https://<tenant-name>-app.papermerge.com.

API-Endpunkte

Alle API-Endpunkte enthalten /api/ zwischen dem Server-Host und dem restlichen Endpunkt, zum Beispiel:

curl https://app.papermerge.com/api/users/me -H ...

Beachte, dass Endpunkt-URLs nicht mit einem abschließenden / enden.

Beispiele mit cURL

Hier sind ein paar Beispiele für die Verwendung eines API-Tokens mit dem curl-Client.

Dokument hochladen:

curl https://app.papermerge.com/api/documents/upload \
    -H "Authorization: Bearer pm_MAxxThisxxxisxxxxExamplexxxTokenxxxt7I" \
    -F "file=@/home/frederik/Documents/utility_01.pdf" \
    -F "lang=eng"

Details zum aktuellen Benutzer abrufen:

curl https://app.papermerge.com/api/users/me \
  -H "Authorization: Bearer pm_MAxxThisxxxisxxxxExamplexxxTokenxxxt7I"