Entwickler (API)

Neben der App bietet paperlesspaper auch eine API mit der Entwickler individuelle Anwendungen oder bestehende Systeme integrieren können.

Erste Schritte

Um die API zu verwenden, müssen Sie:

• Einen gültigen API-Schlüssel verwenden, um Anfragen an die API-Endpunkte zu senden.
  Ihren API-Schlüssel erhältst du in der paperlesspaper-Anwendung.
• Nur HTTPS-Verbindungen sind erlaubt. Anfragen über HTTP werden per HTTP 301-Redirect auf HTTPS umgeleitet.
• Die API gibt Antworten im JSON-Format zurück. Fehler erscheinen im JSON-Body unter dem Schlüssel error.

Wie erstelle ich Tokens?

Du kannst API-Keys in Ihren Benutzereinstellungen generieren.

Wo finde ich die Dokumentation der API?

Du findest die Dokumentation hier.

Authentifizierung

Die API verwendet zwei Authentifizierungsmethoden:
Eigene API-Tokens und Auth0 JWT-Tokens.

API-Token-Authentifizierung

Du kannst ein benutzerdefiniertes API-Token in der paperlesspaper-App oder über Ihren Administrator generieren.
Zur Authentifizierung füge den API-Token dem Authorization-Header als Bearer-Token hinzu:

Authorization: Bearer <Ihr-Token>

• Das API-Token muss ein 64-stelliger Hexadezimalwert sein.
• Ist das Token gültig, wird die Anfrage im Namen des zugehörigen Benutzers authentifiziert.

Fehlermeldungen zur Authentifizierung

• 401 Unauthorized: Token fehlt, ist ungültig oder abgelaufen.
• 403 Forbidden: Authentifiziert, aber keine Berechtigung für den Endpunkt.

Rate- und Nutzungslimits

Die Zugriffsbeschränkungen gelten pro API-Key und Zeiteinheit.
Das Limit beträgt 300 Anfragen pro Minute.
Zusätzlich können je nach Tarif weitere Nutzungslimits gelten.
Bei Überschreiten erhältst du den HTTP-Status 429 Too Many Requests.

HTTP 503 Antwort

Ein HTTP-503-Fehler zeigt eine unerwartete Spitzenlast im API-Zugriff.
Der Server ist in der Regel innerhalb von fünf Minuten wieder verfügbar.
Bei anhaltender Störung oder anderen HTTP 5XX-Fehlern wenden dich bitte an den Support.