Documentatie

API Key

Na aanmelding krijg je van Postcoders een API Key waarmee je gebruik kunt maken van de API.

Implementatie

De API van Postcoders is eenvoudig te implementeren. Op basis van de postcode en huisnummer geeft deze de benodigde informatie terug.

Voorbeeld

- Postcode: 3455 RR
- Huisnummer: 1

De aanroep van de APi gaat dan als volgt:

Get request

curl -H 'Authorization: token [token]' 
https://postcoders.nl/api/v1/by/postalcode-housenumber/3455RR/1

Response

{
    "street":"Kasteellaan",
    "place":"Haarzuilens",
    "houseNumber":1,
    "latitude":52.1211,
    "longitude":4.9872,
    "province":"Utrecht",
    "postalCode":"3455RR",
    "municipality":"Utrecht",
    "suffixes":[""]
}

Voorbeeld met huisnummer toevoeging

- Postcode: 3013 AD
- Huisnummer: 19
- Toevoeging: E

De aanroep van de APi gaat dan als volgt:

Get request

curl -H 'Authorization: token [token]' 
https://postcoders.nl/api/v1/by/postalcode-housenumber/3013AD/19E

Response

{
    "street":"Delftsestraat",
    "place":"Rotterdam",
    "houseNumber":19,
    "latitude":51.925,
    "longitude":4.4753,
    "province":"Zuid-Holland",
    "postalCode":"3013AD",
    "municipality":"Rotterdam",
    "suffixes":["A","B","C","D","E"]
}

Als je een eigen API key hebt kun je bovenstaande API call eenvoudig testen met Postman
Run in postman

Responses

De API van Postcoders geeft een na het aanroepen van de API een HTTP status terug:

200 Ok:

Adres is gevonden in de database en API heeft de bijbehorende informatie teruggegeven.

400 Bad request:

In dit geval is de aanvraag niet goed, dit kan zijn omdat het huisnummer niet een integer is of dat de postcode niet het goede formaat is (4 cijfers 2 letters).

401 Not authorized:

De API key is niet meegegeven of niet (meer) valide.

404 Not found:

Als er geen adres gevonden kan worden.