Publieke API
- Niels
Authenticatie
Voor authenticatie wordt OAuth2 gebruikt. Het token endpoint is: https://berger.assistanceonline.nl/auth/connect/token de scope is ao-public-api. Zie onderstaande curl voorbeeld (vervang CLIENT_ID en CLIENT_SECRET door jouw gegevens):
curl -X POST \
https://berger.assistanceonline.nl/auth/connect/token \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'client_id=CLIENT_ID&client_secret=CLIENT_SECRET&grant_type=client_credentials&scope=ao-public-api'Als response volgt er een token in de vorm van een JWT (JSON Web Token), met hierin dus het access_token deze dient als authorization-header meegestuurd te worden met de API calls:
Authorization: Bearer <token>Beperkingen
Voor de API zijn enkele beperkingen van toepassing waar de aanroeper rekening mee dient te houden.
Token geldigheid
Zo is je token maar 1 uur geldig, de geldigheidsduur wordt meegestuurd bij het opvragen van het token. Hierna moet een nieuw token opgevraagd worden.
Ratelimit
Tevens is er een beperking in het aantal requests dat vanaf een IP adres gedaan mag worden op deze API. Deze limiet is maximaal 15 per seconden en daarbij totaal 3600 per uur. Mochten requests te snel elkaar opvolgen dan volgt de volgende foutmelding:
HTTP 429 Too Many Requests
retry-after: 1
API calls quota exceeded! maximum admitted 15 per 1s.De retry-after-header geeft aan dat het na 1 seconde opnieuw geprobeerd mag worden.
Bij geslaagde aanroepen worden de volgende headers meegestuurd:
Hierbij zie je dat er binnen 1 uur nog 3596 aanroepen gedaan mogen worden en wanneer de teller weer gereset wordt.
Endpoints
Om alle beschikbare endpoints te bekijken is de volgende Swagger pagina beschikbaar:
Productie: https://berger.assistanceonline.nl/api/public/v1/swagger/
Test: https://berger.test.assistanceonline.nl/api/public/v1/swagger/
Meer informatie:
Â