Entwickler (API)

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

Die API ist derzeit in der Beta. Es kann also sein, dass sich in Zukunft einige Dinge ändern werden.

Alle Informationen rund um die API und andere Möglichkeiten findest du bei GitHub.

Erste Schritte

Um die API zu verwenden, musst du:

• 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 deinen Benutzereinstellungen generieren.

Wo finde ich die Dokumentation der API?

Du findest die Dokumentation der API 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 generieren.
Zur Authentifizierung füge den API-Token dem x-api-key-Header hinzu:

x-api-key: <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.
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.

Deep Linking in die App

Die App unterstützt Deep Linking, wodurch sich Benutzer aus anderen Anwendungen oder Webseiten direkt zu bestimmten Funktionen oder Seiten in der App navigieren lassen.

Beispiel

https://web.wirewire.de/account

Verlinkt, wenn die App installiert ist direkt in die Accounteinstellungen

https://web.wirewire.de/account#no_universal_links

Mit dem Hash #no_universal_link kann das Deep Linking deaktivert werden.