Ontwikkelaar (API)

Direct naar de API-documentatie: docs.paperlesspaper.de

Naast de app biedt paperlesspaper ook een API waarmee ontwikkelaars individuele toepassingen of bestaande systemen kunnen integreren.

De API bevindt zich momenteel in bèta. Het kan dus zijn dat er in de toekomst enkele zaken zullen veranderen.

Alle informatie over de API en andere mogelijkheden vind je op GitHub.

Eerste stappen

Om de API te gebruiken, moet je:

• Een geldige API-sleutel gebruiken om verzoeken naar de API-eindpunten te sturen.
  Je ontvangt je API-sleutel in de paperlesspaper-app.
• Alleen HTTPS-verbindingen zijn toegestaan. Verzoeken via HTTP worden per HTTP 301-redirect naar HTTPS omgeleid.
• De API geeft antwoorden in JSON-formaat terug. Fouten verschijnen in de JSON-body onder de sleutel error.

Hoe maak ik tokens aan?

Je kunt API-sleutels in je Gebruikersinstellingen genereren.

Waar vind ik de documentatie van de API?

Je vindt de documentatie van de API hier.

API-tokenauthenticatie

Je kunt een aangepast API-token genereren in de paperlesspaper-app.
Voor authenticatie voeg je het API-token toe aan de x-api-key-header toe:

x-api-key: <jouw-token>

• Het API-token moet een hexadecimale waarde van 64 tekens zijn.
• Als het token geldig is, wordt het verzoek geauthenticeerd namens de bijbehorende gebruiker.

Foutmeldingen bij authenticatie

• 401 Unauthorized: Token ontbreekt, is ongeldig of verlopen.
• 403 Forbidden: Geauthenticeerd, maar geen toestemming voor dit eindpunt.

Rate- en gebruikslimieten

De toegangsbeperkingen gelden per API-sleutel en tijdseenheid.
Het limiet bedraagt 300 aanvragen per minuut.
Bij overschrijding ontvang je de HTTP-status 429 Too Many Requests.

HTTP 503-respons

Een HTTP 503-fout duidt op een onverwachte piekbelasting bij het API-verkeer.
De server is meestal binnen vijf minuten weer beschikbaar.
Bij aanhoudende storing of andere HTTP 5XX-fouten neem je contact op met de Support.

Deep linking in de app

De app ondersteunt deep linking, waardoor gebruikers vanuit andere apps of webpagina's direct naar bepaalde functies of pagina's in de app kunnen navigeren.

Voorbeeld

https://web.paperlesspaper.de/account

Linkt, als de app geïnstalleerd is, direct naar de accountinstellingen

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

Met de hash #no_universal_link kan het deep linking worden uitgeschakeld.