Ontwikkelaar (API)

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

Eerste stappen

Om de API te gebruiken, moet u:

• Een geldige API-sleutel gebruiken om verzoeken naar de API-eindpunten te sturen.
  Uw API-sleutel ontvangt u in de paperlesspaper-toepassing.
• Alleen HTTPS-verbindingen zijn toegestaan. Verzoeken via HTTP worden via HTTP 301-omleiding 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 genereren in je gebruikersinstellingen.

Waar vind ik de documentatie van de API?

Je vindt de documentatie hier.

Authenticatie

De API gebruikt twee authenticatiemethoden:
Eigen API-tokens en Auth0 JWT-tokens.

API-token-authenticatie

Je kunt een aangepast API-token genereren in de paperlesspaper-app of via je beheerder.
Voor authenticatie voeg je het API-token toe aan de Authorization-header als een Bearer-token:

Authorization: Bearer <je-token>

• Het API-token moet een 64-cijferige hexadecimale waarde 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 het eindpunt.

Snelheids- en gebruikslimieten

De toegangsbeperkingen gelden per API-sleutel en tijdseenheid.
De limiet is 300 verzoeken per minuut.
Afhankelijk van het tarief kunnen er extra gebruikslimieten gelden.
Bij overschrijding ontvang je de HTTP-status 429 Too Many Requests.

HTTP 503 Antwoord

Een HTTP-503-fout geeft een onverwachte piekbelasting in API-toegang aan.
De server is meestal binnen vijf minuten weer beschikbaar.
Bij aanhoudende storing of andere HTTP 5XX-fouten neem je contact op met de support.