De Zoeken API heeft een upgrade gekregen. Hieronder lees je wat er allemaal veranderd is ten opzichte van versie V1.
Endpoint
De nieuwe endpoint is:
https://api.kvk.nl/api/v2/zoeken
Binnenlandse en buitenlandse adressen bij output
Zoeken V2 maakt onderscheid tussen binnen- en buitenlandse adressen.
Een buitenlands adres herken je aan deze attributen:
- straatHuisnummer
- postcodeWoonplaats
- land
Binnenlands adres - V1
"adresType": "string", "straatnaam": "string", "huisnummer": 0, "huisnummerToevoeging": "string", "postcode": "string", "plaats": "string",
Binnenlands adres - V2
"adres": { "binnenlandsAdres": { "type": "bezoekadres/postadres", "straatnaam": "string", "huisnummer": 0, "huisletter": "string", "postbusnummer": 0, "postcode": "string", "plaats": "string", } }
Buitenlands adres - V1
"adresType": "string", "straatnaam": "string", "plaats": "string",
Buitenlands adres - V2
"adres": { "buitenlandsAdres": { "type": "bezoekadres/postadres", "straatHuisnummer": "string", "postcodeWoonplaats": "string", "land": "string", } }
“_links” object
Het resultaat bevat in V2 een “_links” object. Daarin bevat het attribuut “self” de URL naar de gemaakte aanroep.
{ "pagina": 1, "resultatenPerPagina": 10, "totaal": 10, "resultaten": [...], "_links": { "self": { "href": "https://api.kvk.nl/test/api/v2/zoeken" } } }
Verschillen output
| V1 (oud) | V2 (nieuw) | Omschrijving |
|---|---|---|
| aantal | resultatenPerPagina | Het attribuut ‘aantal’ is verduidelijkt en aangepast naar ‘resultatenPerPagina’. |
| handelsnaam | naam | Attribuut ‘handelsnaam’ is aangepast naar ‘naam’, zodat het nu duidelijk is dat er niet enkel handelsnaam wordt getoond. De naam kan een ‘statutaire naam’, ‘handelsnaam’ of ‘naam (niet-commercieel)’ zijn. |
| <losse adresgegevens> | adres | Adres gegevens worden niet meer los weergegeven, maar in een object ‘adres’ waarin een ‘binnenlandsAdres’ of ‘buitenlandsAdres’ weergegeven wordt. Zie hierboven bij binnen- en buitenlandse adressen. |
Verschillen input
| V1 (oud) | V2 (nieuw) | Omschrijving |
|---|---|---|
| aantal | resultatenPerPagina | Het attribuut ‘aantal’ is verduidelijkt en aangepast naar ‘resultatenPerPagina’. |
| handelsnaam | naam | Attribuut ‘handelsnaam’ is aangepast naar ‘naam’, zodat het nu duidelijk is dat er niet enkel handelsnaam wordt getoond. De naam kan een ‘statutaire naam’, ‘handelsnaam’ of ‘naam (niet-commercieel)’ zijn. |
| huisnummer | huisnummer | Functionaliteit is aangepast: in de V2 is het niet meer mogelijk om parameter huisnummer te gebruiken om een postbusnummer op te zoeken, gebruik hiervoor de nieuwe parameter |
| <n.v.t.> | postbusnummer | Voorheen werd het postbusnummer als huisnummer parameter meegegeven. Bij de V2 is hier een postbusnummer parameter voor geïntroduceerd. |
| huisnummerToevoeging | huisletter | Parameternaam is verduidelijkt. |
| type | type | De naam van de parameter is hetzelfde gebleven maar de manier van het aanroepen van de parameter is anders. In de V1 is het gescheiden met een komma en in de V2 is het gescheiden met een & teken en voluit geschreven. Zie onderstaande voorbeelden: |