Vacatures ophalen met de Vacature API (V API)

Op deze pagina lees je alles over de Vacature API (V API).

Wat doet deze API?

Met de Vacature API haal je automatisch vacatures op bij VDAB om ze op te laden in je eigen systeem.

Voorwaarden voor gebruik

  • Je mag de Vacature API gebruiken, nadat VDAB een partnership met jou heeft goedgekeurd en na het ondertekenen van een samenwerkingsovereenkomst.
  • Je mag de Vacature API enkel voor professionele doeleinden gebruiken. 
  • De data-uitwisseling via de API moet een toegevoegde waarde hebben voor jou en voor VDAB.

Vraag de API aan

Functionaliteiten

Met de Vacature API kun je:

  • vacatures ophalen
  • interactief zoeken naar vacatures
  • alle bestaande informatie van een vacature opvragen
  • vacatures synchroniseren in bulk

Deze functionaliteiten zijn beschikbaar via de vijf endpoints van de Vacature API:

  • GET/vacatures/initial

    Het aanroepen van dit endpoint geeft een lijst van vacatures en hun status (altijd status “GEPUBLICEERD”) terug, op een bepaalde datum. 

  • GET/vacatures (interactief zoeken)

    Bij het aanroepen van dit endpoint stel je verschillende selectiefilters in om een gewenste set van vacatures te bekomen.

  • GET/vacatures/{id}

    Het aanroepen van dit endpoint geeft alle bestaande info van één bepaalde vacature.

  • POST/vacatures

    Het aanroepen van dit endpoint geeft bestaande info van meerdere vacatures door vacaturenummers toe te voegen aan je verzoek.

  • GET/vacatures/bulk (bulk synchronisatie)

    Het aanroepen van dit endpoint geeft als resultaat alle vacatures die aangemaakt, gewijzigd of verwijderd zijn in een bepaalde tijdsspanne.

Paginering

Zowel voor het 'initieel ophalen', het 'interactief zoeken' als het 'in bulk synchroniseren' wordt paginering gebruikt om het aantal resultaten per call te beperken.

Beveiliging

VDAB gebruikt de API-sleutel als authenticatiemiddel en vereist HTTPS-verbindingen die versleuteld zijn via TLS1.2 (of hoger) om de veiligheid te garanderen. Dit betekent dat de VDAB API’s alleen kunnen worden benaderd via het beveiligde HTTPS protocol. Alle API clients die we publiceren gebruiken HTTPS.

Authenticatie en autorisatie

VDAB biedt enkel authenticatie aan via een API-sleutel. Dat is een unieke lange cijfercode. Met deze sleutel herkent de API de gebruiker.

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 systeem.

We geven hieronder een voorbeeld van een mogelijke zoekopdracht.

 

Voorbeeld mei 2024:

 
Stap 1: Zoek vacatures in 'management' in 9000 (Gent)
Aanvraag via GET /vacatures

Criteria: 

  • jobdomein=JOBCAT15 (management)
  • postcode=9000 (Gent)

Het criterium 'JOBCAT15 (management)' kan je opvragen via de Referentie API - subproduct Jobdomeinen. Zie ook de info over de Referentie API.

Resultaat 23-05-2024:

Deze zoekopdracht geeft 539 resultaten terug (gepagineerd afgebeeld, limiet van 15 vacatures per pagina)

 
Stap 2:  Inzoomen op één vacature van de opgevraagde vacaturelijst
Aanvraag via GET /vacatures/{id}

Resultaat 23-05-2024: 

Deze aanroep geeft het detail van één specifieke vacature weer.