Utvecklare (API)

Direkt till API-dokumentationen: docs.paperlesspaper.de

Utöver appen erbjuder paperlesspaper även en API som utvecklare kan integrera egna applikationer eller befintliga system.

API:t är för närvarande i beta. Det kan alltså hända att vissa saker ändras i framtiden.

All information om API:t och andra möjligheter hittar du på GitHub.

Kom igång

För att använda API:t måste du:

• Använd en giltig API-nyckel för att skicka förfrågningar till API-slutpunkterna.
  Din API-nyckel hittar du i paperlesspaper-appen.
• Endast HTTPS-anslutningar är tillåtna. Förfrågningar via HTTP omdirigeras med en HTTP 301-omdirigering till HTTPS.
• API:t returnerar svar i JSON-format. Fel visas i JSON-body under nyckeln error.

Hur skapar jag tokens?

Du kan generera API-nycklar i dina användarinställningar.

Var hittar jag API-dokumentationen?

Du hittar API-dokumentationen här.

API-tokenautentisering

Du kan generera ett anpassat API-token i paperlesspaper-appen.
För autentisering, lägg till API-tokenet i x-api-key-headern:

x-api-key: <ditt-token>

• API-tokenet måste vara ett 64 tecken långt hexadecimalt värde.
• Om tokenet är giltigt autentiseras förfrågan i den tillhörande användarens namn.

Felmeddelanden för autentisering

• 401 Unauthorized: Token saknas, är ogiltigt eller har gått ut.
• 403 Forbidden: Autentiserad, men saknar behörighet för slutpunkten.

Hastighets- och användningsbegränsningar

Begränsningarna för åtkomst gäller per API-nyckel och tidsenhet.
Gränsen är 300 förfrågningar per minut.
Vid överskridande får du HTTP-statusen 429 Too Many Requests.

HTTP 503-svar

Ett HTTP 503-fel indikerar en oväntad toppbelastning i API-åtkomsten.
Servern är vanligtvis tillgänglig igen inom fem minuter.
Vid fortsatt störning eller andra HTTP 5XX-fel, vänligen kontakta supporten.

Deep Linking i appen

Appen stöder deep linking, vilket gör att användare från andra appar eller webbplatser kan navigera direkt till specifika funktioner eller sidor i appen.

Exempel

https://web.paperlesspaper.de/account

Länkar direkt till kontoinställningarna när appen är installerad.

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

Med hash-tecknet #no_universal_link kan deep linking inaktiveras.