Documentatie

De API is bewust heel simpel gehouden. Er is maar 1 method beschikbaar (query), de aanroep is daarom heel eenvoudig.

Je kunt de API aanroepen door een GET request uit te voeren naar:

https://api.adres-check.nl/query/{postcode}/{huisnummer}

Vervang in dit voorbeeld je {postcode} voor de postcode en {huisnummer} voor het huisnummer.

GET https://api.adres-check.nl/query/1071XX/1

Geef daarbij in de request headers de volgende header mee: 'X-API-KEY'. Hier gebruik je de API-KEY die je hebt ontvangen per mail. Dit wordt gebruikt om toegang te verlenen en het aantal requests te registreren. Houdt deze KEY daarom voor jezelf. Het maakt niet uit vanuit waar/welk IP adres of hoeveel clients je requests uit laat voeren, als het maar binnen de maximaal aantal requests per maand blijft.

Een voorbeeld request met bijvoorbeeld curl vanaf de command-line kan zijn:

user@macbook ~ % curl -H "X-API-KEY: 2fe0e58aa1a4a4b8e36fa0337b9e624f" "https://api.adres-check.nl/query/1071XX/1"
[{"Street":"Museumstraat","City":"Amsterdam","Province":"Noord-Holland"}]%

Een voorbeeld voor PHP:

<?php

$url = "https://api.adres-check.nl/query/1071XX/1";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = [
   "X-API-KEY: 2fe0e58aa1a4a4b8e36fa0337b9e624f",
];
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);

?>

Responses

Hieronder vind je een overzicht van enkele testgevallen en de bijbehorende response. Als een adres gevonden is krijg je altijd een 200 OK terug. Indien een adres niet is gevonden, een 404 Not Found.

200 OK {"Street":"Museumstraat","City":"Amsterdam","Province":"Noord-Holland"} 

404 Not Found {"message":"No address found."}

400 Bad Request {"message":"Invalid housenr format."}

400 Bad Request {"message":"Invalid postal code format."}