CV's ophalen met de CV API
Op deze pagina lees je alles over cv's ophalen met de CV API.
Wat doet deze API?
Met de CV API haal je automatisch cv’s op bij VDAB om ze op te laden in je eigen systeem.
Voor wie?
Iedereen die een door dPM (digitaal Partner Management) goedgekeurde partnership heeft afgesloten, mag de CV API gebruiken.
Functionaliteiten
We beschrijven hier wat deze API kan en waar je best rekening mee houdt.
De CV API biedt ondersteuning voor zowel 'bulk-synchronisatie' als 'interactief zoeken'.
- Het /kandidaten/bulk end point geeft als resultaat alle cv id’s die in een bepaalde tijdspanne aangemaakt, gewijzigd of verwijderd zijn.
- Via het /kandidaten/{id} detail end point kunnen de bekomen cv’s dan één per één opgehaald worden of uit de eigen database verwijderd worden, afhankelijk van de verkregen status.
- Via het /kandidaten end point kan een zoekfunctie geïmplementeerd worden met de gewenste zoekparameters. Hierbij is het mogelijk om een beperkt aantal velden te selecteren die in de lijst teruggeven moeten worden. Optioneel kan het detail van de cv opgehaald worden indien alle informatie gewenst is (via kandidaten/{id}).
Zowel voor het interactief zoeken als het bulk zoeken wordt paginering gebruikt om het aantal resultaten per call te beperken.
Definities
Er is een belangrijk verschil in betekenis en gebruik van de referentie-data 'studieboom' en 'diploma’s':
- Studieboom
- Dit is de 'Studieboom API vdab' om studieniveau's op te zoeken.
- Je gebruikt deze API niet in combinatie met de Vacatures API en de CV API, gebruik daarvoor 'Diploma's'.
- Diploma's
- Dit is de referentie API voor studies en diplomas.
- Je gebruikt deze in combinatie met de vacatures 2.0 API en de CV 1.0 API.
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 biedt 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 bij deze API:
Voorbeeld: Zoek Handelsingenieurs in de regio Aalst
Stap 1: Aanvraag via GET /kandidaten
Criteria:
- studies=MAE5AHH (Master TEW: Handelsingenieur)
- gewensteRegios=BE231A (regio Aalst)
Het criterium 'MAE5AHH (Master TEW: Handelsingenieur)' kan je opvragen via de Referentie API - subproduct Diploma's. Meer over Referentie-API.
Resultaat:
Deze zoekopdracht geeft 7 dossiers als resultaat.
GET https://api.vdab.be/services/openservices/v1/kandidaten?studies=MAE5AHH&gewensteRegios=BE231A
Headers:
Accept: application/json
X-IBM-Client-Id: ********-****-****-****-************
{
"aantal": 7,
"resultaten": [
{
"cvId": "0f263a0e-cd00-4325-8ce3-4163740c101d"
},
{
"cvId": "e67fe67c-1e06-4bfb-aa13-4c7532938100"
},
{
"cvId": "9cd21b39-92e5-451e-990d-58029ece4e67"
},
{
"cvId": "30966b99-ed6d-40d3-be16-053c6d040327"
},
{
"cvId": "0d3c13b1-b7f8-4dc1-9728-339d555a9048"
},
{
"cvId": "cb60cf85-1380-4a5a-adae-0b7bc6160661"
},
{
"cvId": "d2e6e03f-1acd-4d03-a44a-5b735343eb9b"
}
]
}
Stap 2: Individuele cv's opvragen via GET /kandidaten/{id}
We vragen de details van het voorlaatste dossier op.
GET https://api.vdab.be/services/openservices/v1/kandidaten/cb60cf85-1380-4a5a-adae-0b7bc6160661
Headers:
Accept: application/json
X-IBM-Client-Id: ********-****-****-****-************
{
"cvId": "cb60cf85-1380-4a5a-adae-0b7bc6160661",
"status": "OPEN",
"wijzigingsDatum": "2022-07-27",
"iklId": ******,
"persoonlijkeInteresse": {},
"natuurlijkPersoon": {
"gsm": "+32477******",
"officieelAdres": {
"straat": "*************",
"huisnummer": "*",
"busnummer": "D001",
"postcode": "BE-2800",
"gemeente": "2800-MECHELEN",
"land": "BE"
},
"contactAdres": {
"straat": "*************",
"huisnummer": "*",
"busnummer": "D001",
"postcode": "BE-2800",
"gemeente": "2800-MECHELEN",
"land": "BE"
},
Nog ter illustratie, de volledige details van een ander dossier:
GET https://api.vdab.be/services/openservices/v1/kandidaten/30dbfef1-59df-4521-a111-964bf0208e68
Headers:
Accept: application/json
X-IBM-Client-Id: ********-****-****-****-************
{
"cvId": "30dbfef1-59df-4521-a111-964bf0208e68",
"status": "OPEN",
"wijzigingsDatum": "2022-08-03",
"iklId": 11116485,
"persoonlijkeInteresse": {},
"natuurlijkPersoon": {
"gsm": "0474xxxxxx",
"officieelAdres": {
"straat": "xxxstraat",
"huisnummer": "xx",
"postcode": "BE-1770",
"gemeente": "1770-LIEDEKERKE",
"land": "BE"
},
"contactAdres": {
"straat": "xxxstraat",
"huisnummer": "xx",
"postcode": "BE-1770",
"gemeente": "1770-LIEDEKERKE",
"land": "BE"
},
"email": "Dxxx@yahoo.com",
"achternaam": "Mxxx",
"voornaam": "Dxxx",
"roepnaam": "Dxxx",
"website": "https://www.linkedin.com/in/dxxx",
"geslacht": "M",
"nationaliteit": "BE",
"geboortedatum": "19xx-09-05"
},
"ervaringen": [
{
"type": "werkervaring",
"functieTitel": "COO - Facility & Operations Manager",
"van": "2020-11-01",
"werkgever": {
"naam": "DSB Print"
},
"tot": "2021-04-30"
},
{
"type": "werkervaring",
"functieTitel": "ICT Project Leader (Securex)",
"van": "1999-07-01",
"werkgever": {
"naam": "Dolmen CA"
},
"tot": "2000-08-31"
},
{
"type": "werkervaring",
"functieTitel": "Senior Supply Chain Project Manager (Carrefour Belgium)",
"van": "2005-09-01",
"werkgever": {
"naam": "Spikes"
},
"tot": "2017-12-31"
},
{
"type": "werkervaring",
"functieTitel": "Supply Chain Manager",
"van": "2017-12-01",
"werkgever": {
"naam": "Carrefour Belgium"
},
"tot": "2020-11-30"
},
{
"type": "werkervaring",
"functieTitel": "Supply Chain Manager COVID-19",
"van": "2021-04-01",
"werkgever": {
"naam": "Cocom-GGC (BXL)"
}
},
{
"type": "werkervaring",
"functieTitel": "Supply Project Leader (GIB-Group/Carrefour Belgium)",
"van": "2000-08-01",
"werkgever": {
"naam": "Real Software Group"
},
"tot": "2005-09-30"
}
],
"opleidingen": [
{
"type": "studie",
"behaaldOp": "2002-01-01",
"behaaldIn": 2002,
"diploma": true,
"naam": "MAN1NOO"
},
{
"type": "studie",
"info": "Omzetting van Handelsingenieur (UEH5AHH) dd. 01/07/2011",
"behaaldOp": "1999-01-01",
"behaaldIn": 1999,
"diploma": true,
"naam": "MAE5AHH"
}
],
"attesteringen": [
{
"type": "rijbewijs",
"code": "B",
"eigenWagen": true
}
],
"competenties": [
{
"type": "talen",
"code": "D",
"niveau": "1"
},
{
"type": "talen",
"code": "E",
"niveau": "3"
},
{
"type": "talen",
"code": "F",
"niveau": "3"
},
{
"type": "talen",
"code": "N",
"niveau": "3"
},
{
"type": "technischeCompetentie",
"code": "11721",
"score": "43"
},
{
"type": "technischeCompetentie",
"code": "18138",
"score": "43"
},
{
"type": "technischeCompetentie",
"code": "24557",
"score": "42"
},
{
"type": "technischeCompetentie",
"code": "16394",
"score": "42"
},
{
"type": "technischeCompetentie",
"code": "18599",
"score": "42"
},
{
…
},
{
"type": "softSkill",
"code": "12"
},
{
"type": "softSkill",
"code": "8"
},
{
"type": "softSkill",
"code": "10"
},
{
"type": "softSkill",
"code": "5"
},
{
"type": "softSkill",
"code": "9"
},
{
"type": "technischeCompetentie",
"code": "22232",
"score": "42"
},
{
"type": "technischeCompetentie",
"code": "16669",
"score": "42"
},
{
…
},
{
"type": "vrijeCompetentie",
"naam": "Organisation & coordination skills",
"beschrijving": "Organisation & coordination skills"
},
{
"type": "vrijeCompetentie",
"naam": "Diplomatic & negotiater",
"beschrijving": "Diplomatic & negotiater"
},
{
"type": "vrijeCompetentie",
"naam": "People Mangement: communicative & coaching",
"beschrijving": "People Mangement: communicative & coaching"
},
{
"type": "vrijeCompetentie",
"naam": "Stress consistent & customer-oriented",
"beschrijving": "Stress consistent & customer-oriented"
},
{
"type": "vrijeCompetentie",
"naam": "Analytical with strong helicopter view",
"beschrijving": "Analytical with strong helicopter view"
}
],
"gewensteJob": {
"arbeidsRegimes": [
"V"
],
"arbeidsStelsels": [
"D"
],
"regios": [
"BE1",
"BE231A",
"BE231B",
"BE234B",
"BE241A",
"BE241B"
],
"functies": [
{
"titel": "Adviseur bedrijfsorganisatie en management",
"ervaring": "4",
"beroepsprofiel": {
"code": "M140201-1"
}
},
{
"titel": "Directeur van een kleine of middelgrote organisatie",
"ervaring": "4",
"beroepsprofiel": {
"code": "M130201-1"
}
},
{
"titel": "Logistiek verantwoordelijke",
"ervaring": "4",
"beroepsprofiel": {
"code": "N130101-1"
}
},
{
…
}
},
{
"titel": "Verantwoordelijke logistieke site ",
"ervaring": "4",
"beroepsprofiel": {
"code": "N130201-1"
}
},
{
"titel": "Verantwoordelijke planning en productiebeheer",
"ervaring": "4",
"beroepsprofiel": {
"code": "H140101-1"
}
},
{
"titel": "Verantwoordelijke productiemethodes en industrialisatie ",
"ervaring": "4",
"beroepsprofiel": {
"code": "H140201-1"
}
}
]
}
}