Documentatie

Introductie

Postcodetools.nl is een adresvalidatie tool. Door middel van deze applicatie kan je je adres gegevens checken op fouten of incomplete adresgegevens bijvullen.

Benodigdheden

Om gebruik te kunnen maken van deze applicatie dien je eerst een account aan te maken. Dit kan je gemakkelijk doen door middel van het registratie formulier.

Na het aanmaken van een account wordt je doorgestuurd naar de abonnementen pagina. Op deze pagina kies je het abonnement die het beste bij jou past. Je kan op iedere moment je abonnement up- of downgraden.

Wanneer je een abonnement hebt gekozen kan je door middel van de API Keys pagina een key aanmaken. Deze API Keys geven andere applicaties toegang tot jouw account. Wanneer je een key hebt kan je beginnen met het implementeren van postcodetools.nl.

Techniek

Postcodetools.nl is door andere applicaties te implementeren door een GET request te sturen naar het volgende URL.

Om de API te kunnen benutten dien je je API key mee te sturen in een header.

Een complete request ziet er dus zo uit.

cURL voorbeeld.

De response zal het volgende structuur hebben.

{
    "huisnummer": "27",
    "huisletter": null,
    "huisnummertoevoeging": null,
    "postcode": "5611CJ",
    "straatnaam": "Dommelstraat",
    "woonplaats": "Eindhoven",
    "land": "Nederland"
}

Code	Betekenis
200	Succes Wij hebben een adres gevonden.
403	Toegang geweigerd Dit kan betekenen dat je abonnement verlopen is of je hebt al je toegestane requests gebruikt voor deze maand.
404	Geen adres gevonden Er is geen adres gevonden met de gegeven gegevens.
429	API Rate limit bereikt Je hebt te veel requests gestuurd in een te korte tijdsperiode.