API-register: Overzicht

API van het API-register van developer.overheid.nl.

Untrusted clients (API-key)

Untrusted clients hebben geen schrijfrechten maar wel leesrechten. Requests kunnen, ook vanuit de browser, eenvoudig gedaan worden door de verkregen API-key aan elke request mee te geven met de X-Api-Key header:

X-Api-Key: {API_KEY} (vervang {API_KEY} met de verkregen API-key)

Trusted clients (client-credentials flow)

Trusted clientst hebben zowel schrijfrechten als leesrechten. Bij elke request moet er een access_token meegestuurd worden. Deze token is 5 minuten geldig en kan verkregen worden door een POST request te doen naar https://auth.developer.overheid.nl/realms/don/protocol/openid-connect/token met de volgende Form URL Encoded body:

• grant_type: client_credentials
• scope: apis:write apis:read organisations:read
• client_id: {CLIENT_ID} (vervang {CLIENT_ID} met de client id die je van ons hebt ontvangen
• client_secret: {CLIENT_SECRET} (vervang {CLIENT_SECRET} met de client secret die je van ons hebt ontvangen

De verkregen access_token stuur je vervolgens op de volgende manier met de Authorization header naar een request mee:

Authorization: Bearer {ACCESS_TOKEN} (vervang {ACCESS_TOKEN} met de verkregen access_token)

Paginering

Paginering bij collecties vindt plaats door middel van de Link header. Er zijn verschillende libraries beschikbaar (zoals parse-link-header voor Javascript) die deze header kan parsen. Verder geven de volgende headers extra houvast om paginering in de client te implementeren: X-Current-Page, X-Per-Page, X-Total-Count en X-Total-Pages.