Aan de slag

Quickstart: je eerste API-request

Begin bij de machine identity, doe daarna een begrensde search en open een model of source. Alle voorbeelden gebruiken rechtstreeks de publieke productie-API.

Aan de slag

1Kies endpoint
2Lees metadata
3Behoud grenzen

Start met metadata en zoekresultaten voordat je modelcontext in een toepassing verwerkt.

Lees eerst de API-identiteit

Gebruik /v1/meta om de actieve API-, schema- en knowledgeversie, populatie, scope en classificaties te lezen. Zo koppel je opgeslagen resultaten aan de release waaruit ze kwamen.

Vijf publieke GET-requests

bash

curl "https://api.kentekenkompas.nl/v1/meta"
curl "https://api.kentekenkompas.nl/v1/knowledge/search?q=Welke%20carrosserie%C3%ABn%20heeft%20de%20BMW%203-serie%3F&limit=5"
curl "https://api.kentekenkompas.nl/v1/models/volkswagen-golf"
curl "https://api.kentekenkompas.nl/v1/sources/rdw-open-data"
curl "https://api.kentekenkompas.nl/v1/terms/terugroepactie"

JavaScript fetch

Een browser of JavaScript-runtime kan de publieke endpoint rechtstreeks benaderen. Controleer altijd eerst response.ok voordat je JSON verwerkt.

Meta ophalen met fetch

javascript

const response = await fetch("https://api.kentekenkompas.nl/v1/meta");

if (!response.ok) {
  throw new Error(`API-response: ${response.status}`);
}

const meta = await response.json();
console.log(meta.knowledgeVersion);

Lees de actieve release uit de response

De live /v1/meta-response is de bron voor knowledgeVersion, bundlehash, generatietijd en objectaantallen. Kopieer die waarden niet als vaste constanten naar een integratie of documentatiepagina.

Knowledge-responses gebruiken daarnaast een envelope die data scheidt van beschikbare evidence, sources, freshness en limitations. coverage en citationUrl zijn endpointspecifiek en staan niet in iedere response.

Model lookup

Haal stabiele identifiers eerst uit /v1/models. Een modeldetail bevat modelbrede kennis en context; bouwjaar, uitvoering, onderhoud en staat van een individuele auto blijven buiten deze lookup.

Volkswagen Golf modelkennis

bash

curl "https://api.kentekenkompas.nl/v1/models/volkswagen-golf"

Source en term lookup

Een source-response beschrijft onderliggende provenance. Een term-response legt uit wat een voertuigbegrip wel en niet zegt. Behoud bij weergave altijd de classificatie, freshness en limitations die de response levert.

RDW Open Data provenance

bash

curl "https://api.kentekenkompas.nl/v1/sources/rdw-open-data"

Term terugroepactie

bash

curl "https://api.kentekenkompas.nl/v1/terms/terugroepactie"

HTTP-statussen en HEAD

StatusBetekenis voor de integratie
200De gevraagde representation is beschikbaar.
304De representation is niet gewijzigd voor een geldige If-None-Match request.
400De request is ongeldig, bijvoorbeeld door een ongeldige searchquery of limiet.
404Een gevraagde model-, answer-, term- of source-ID bestaat niet publiek.
414De request-URI is te lang.
429De request is begrensd door de publieke service.
503De knowledge release of benodigde data is tijdelijk niet beschikbaar.

GET en HEAD zijn beschikbaar op alle veertien publieke routes. HEAD levert de headers zonder responsebody. Raadpleeg altijd OpenAPI voor de volledige responseset van de specifieke route.

Ga door naar de API-reference