Ga naar inhoud

Snelstart

Dit is een tutorial, om snel aan de slag te gaan met postcode-api.nl. Postcode-api.nl is een online dienst voor het opzoeken en raadplegen van adressen, met de API's is het mogelijk om adressen op te zoeken op verschillende manieren:

  • DirectMatch API

Zoek naar een adres met behulp van een postcode + huis nummer. Voor een exacte bepaling is bij sommige landen nog een straatnaam nodig.

  • Autocomplete API

Dit is een API die zich goed leent voor het maken van een drilldown menu. Een voorbeeld hiervan heb je vermoedelijk al gezien op de frontpage van: postcode-api.nl .

  • Radius API

De radius API geeft de mogelijkheid om een adres(sen) te zoeken op basis van een latitude en longitude. Vervolgens kan de gebruiker nog een radius van maximaal 500 meter opgeven.

Account aanmaken

Uiteraard is er eerst een account nodig, deze kun je aanmaken via: aanmelden. Het account (2FA) en ook later de betreffende tokens (ACL) kun je extra beveiligen.

Bestellen

Na het registeren van het account, kun je een bestelling plaatsen. Kies hier voor een product uit op de prijzen pagina, kies het plan wat bij jouw keuze past en click/kies voor: "Aan de slag".

Na de bestelling wordt je automatische ingelogd op het portaal

Token

In de portal kan je een token aanmaken (deze heb je nodig om met de API server te communiceren). De API server van postcode-api.nl is bereikbaar op: api.postcode-api.nl .

De token kan je aanmaken via het portal op de tokens pagina. Rechts boven in, kies voor je voor welke dienst (plan) de token dient.
Neem je één plan af bij postcode-api.nl dan kan je direct clicken op: "Token toevoegen".

In het dialoog voor de nieuwe token kan je een naam opgeven en een beschrijving. Deze twee elementen zijn voor je eigen administratie. Als laatste kan je een verval datum uitkiezen, met een maximale verval datum van 1 jaar. Kies een datum uit die goed uitkomt (en niet bijvoorbeeld voor het weekend, of je eigen verjaardag).

Data viewer

De data viewer is een extra hulp middel, heb je bijvoorbeeld het vermoeden dat er iets ontbreekt qua data. Of wil je snel iets nakijken, dan kan je de data viewer gebruiken.

Voor Nederland wordt de BAG dataset gebruikt. Dit houdt ook in dat de officele benaming volgens BAG wordt aangehouden. De zoekmachine van postocde-api.nl kent enkele bekende "synoniemen", voor het zoeken. De alternatieve spelling wordt echter niet gebruikt in de data (json):

  • 's-Gravenhage - Den Haag
  • 's-Hertogenbosch - Den Bosch
  • Fryslân - Friesland

Mis je iets, of heb je iets ontdekt, meldt het dan via feedback of mailen mag natuurlijk ook: info@postcode-api.nl.

Token testen

Het aangemaakte token kan je eenvoudig testen met de wel befaamde curl:

curl --header "Authorization: Bearer $JOUW_TOKEN" https://api.postcode-api.nl/v1/directmatch/nl/3811BN/30
Beter leesbare output ? Gebruik het programma jq:
curl --header "Authorization: Bearer $JOUW_TOKEN" https://api.postcode-api.nl/v1/directmatch/nl/3811BN/30 | jq

De bovenstaande CLI commando's moet resulteren in de volgende output:

[
  {
    "city": "Amersfoort",
    "housenumber": "30",
    "municipality": "Amersfoort",
    "postcode": "3811BN",
    "province": "Utrecht",
    "street": "Krankeledenstraat",
    "location": {
      "rd": [
        155000.0,
        463000.0
      ],
      "wgs84": [
        52.1551744,
        5.38720621
      ]
    }
  }
]

Vanaf hier kan je aan de slag gaan met één van API's !