API Center of Excellence (CoE)

Referentie-data afnemen met de Referentie API

Op deze pagina lees je alles over afnemen van referentie-data met de Referentie API.

Wat doet de Referentie API?

De Referentie API is een hulpproduct dat toelaat referentie-data op te vragen zoals VDAB die gebruikt in zijn systemen. Deze referentie-data kan je vervolgens gebruiken in andere API’s.

De Referentie API is een verzameling van API’s die diverse referentie-data aanbieden. 

Klap alles open
Toon minder - Klap open

Voorwaarden voor gebruik

  • Je mag de Referentie API gebruiken, als je een samenwerkingsovereenkomst hebt ondertekend in het kader van een API waarvoor de Referentie API een ondersteunend product is.
  • Je mag de Referentie API enkel voor professionele doeleinden gebruiken. 

Hoe verloopt de voorbereiding (onboarding)?

Lees hoe je toegang krijgt tot de Referentie API op de pagina 'Hoe verloopt de voorbereiding (onboarding) als je wil starten met API's?'

Vraag de API aan

Vraag de API aan

Beveiliging

VDAB gebruikt de API-sleutel (een unieke lange cijfercode) als authenticatiemiddel. 

De API's kunnen enkel benaderd worden via HTTPS-verbindingen die versleuteld zijn via TLS1.2 (of hoger) om de veiligheid te garanderen.

Hoe testen?

Voorlopig heeft VDAB nog geen aparte testomgeving voor deze API en moet je dus rechtstreeks op de  live-omgeving testen vanuit je eigen toepassing.

Als voorbeeld geven we hieronder een overzicht van de inhoud van de Arbeidsmarkt API die de referentie-data voor 'arbeidsovereenkomst' aanbiedt.

In dit voorbeeld laten we je ook zien hoe je deze referentie-data kan gebruiken om de arbeidsinformatie van een burger - verkregen via de Profiel API - te vertalen.