Einführung

Die Paperarchive API ist eine REST-API, mit der du Dokumentenmanagement in jeden Workflow integrieren kannst - Dokumente hochladen, suchen, kategorisieren und abrufen. Sie ist für Automatisierungen, Integrationen und individuelle Workflows auf Basis deines Dokumentenarchivs konzipiert.

Basis-URL

Alle API-Anfragen gehen an:

https://api.paperarchive.io/v1

Versionierung

Die API wird über den URL-Pfad versioniert. Die aktuelle Version ist v1. Wenn Breaking Changes eingeführt werden, wird eine neue Version veröffentlicht, während die vorherige Version für einen Übergangszeitraum verfügbar bleibt.

Anfrageformat

Die meisten Anfragen sind JSON-codiert mit dem Header Content-Type: application/json. Die Ausnahme ist POST /v1/documents, das multipart/form-data für Datei-Uploads akzeptiert. Query-Parameter werden für Filter und Paginierung bei GET-Endpunkten verwendet.

Antwortformat

Die meisten Antworten liefern JSON mit einer einheitlichen Struktur:

{
  "success": true,
  "data": { ... },
  "total": 42,
  "limit": 50,
  "offset": 0
}

Der Download-Endpunkt GET /v1/document/:id/download liefert einen binären Dateistream. Bei Fehlern enthält die Antwort eine Fehlermeldung:

{
  "success": false,
  "error": "Beschreibung des Fehlers"
}

Schnellstart

Mache deinen ersten API-Aufruf, indem du deine Dokumente auflistest:

curl -H "Authorization: Bearer pa_live_DEIN_KEY" \
  https://api.paperarchive.io/v1/documents

Du brauchst einen API-Schlüssel - siehe die Seite Authentifizierung für die Erstellung.

Integrations-Schnellstarts

Verbinde Paperarchive mit deinen bevorzugten Automatisierungstools und baue in wenigen Minuten leistungsstarke Dokumenten-Workflows.