Requests maken

De Adresdata.net webservice is te bereiken via:

https://api.adresdata.net/

Alleen beveiligde HTTPS verbindingen worden toegestaan.

Formaat

Antwoorden worden teruggegeven in JSON formaat. Succesvolle requests geven een JSON object terug met een result key. Wat er precies in de result staat, verschilt per API. Voorbeeld:

{
    "result": "De data..."
}

Wanneer er een fout optreedt, wordt er een JSON object met een error key teruggegeven. Daarin staat dan een tekstuele omschrijving van de error. Bijvoorbeeld:

{
    "error": "Omschrijving van de fout."
}

Authenticatie

Voor alle API calls is een API key nodig. (Vraag er hier één aan) Het meesturen van de API key gaat via de X-APIKEY header. Voorbeeldheader:

X-APIKEY: 208238c2-b818-4efc-a84e-44c8f714890e

Aan de hand van je persoonlijke API key monitoren wij hoeveel resources je verbruikt. Wanneer je bewust of onbewust over de limiet gaat, zullen we hierover contact met je opnemen. Om misbruik te voorkomen, raden we het aan om niet je key publiek toegankelijk te maken door het bijvoorbeeld in een .html of .js bestand op te nemen.

Hard en soft limit

Betalende gebruikers hebben een zogeheten "Soft Limit". Dat betekent dat de webservice blijft werken, óók wanneer je al over je limiet heen bent.

Daarnaast, hebben alle gebruikers een "Hard Limit". Bij het bereiken van dit aantal stopt de API ermee en kan je geen requests meer doen.
- Gratis gebruikers hebben een hard limit van 200.
- Betalende gebruikers hebben een hard limit van tienmaal hun soft limit. (Bijvoorbeeld: met een soft limit van 1000, heb je een hard limit van 10.000)

Elke succesvolle API call geeft een X-REQUESTS-REMAINING header terug waarin staat hoeveel requests er nog gedaan kunnen worden totdat de hard limit bereikt is.