Referentie-data ophalen met de Referentie API

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

Wat doet de Referentie API?

De Referentie API laat toe referentie-data op te vragen zoals VDAB die gebruikt in haar systemen. Referentie-data zijn data die in andere API's gebruikt worden. 

 

Volgende producten zijn opgenomen in de Referentie API:

  • Diplomas:
    Geeft de eerste 10 diploma's terug die het beste overeenkomen met het opgegeven trefwoord.
  • Studieboom:
    Studieboom API om de VDAB studieniveaus op te zoeken. (Niet te gebruiken in combinatie met de vacatures/cv API, gebruik daarvoor Diplomas.)
  • Rijbewijs:
    • Geeft alle rijbewijs codes en hun beschrijving.
    • Voorbeelden: A1 - Motorfietsen  max 125 cc en 11 kw; BE - Auto's < 3,5t en max. 8 plaatsen met aanhangwagen htm > 750 kg; D_VAK - autobus/autocar > 8 zitplaatsen en aanhangwagen max 750 kg met vakbekwaamheidsattest
  • Jobdomeinen:
    • Geeft alle jobdomein codes en hun beschrijving.
    • Voorbeelden: Juridisch; Horeca en toerisme; Financieel
  • Competent 1 API’s:
    • Sjablonen
    • Competenties
    • Soft skills
  • Attesten:
    • Geeft alle attest-codes en hun beschrijving.
    • Voorbeelden: Duikbrevet; Certificaat Cerga voor gasmonteurs; Ervaringsbewijs van autobuschauffeur (m/v)
  • Arbeidsmarkt (zie voorbeeld bij 'Hoe testen?' verder op deze pagina, deze API bevat informatie over de arbeidsovereenkomst)
    • Arbeidsstelsels (ondermeer dagwerk, 2-ploegenstelsel, weekend, dienstencheques,...)
    • Arbeidsregimes (voltijds of deeltijds)
    • Arbeidscontractduren (bepaalde of onbepaalde duur)
    • Arbeidscontracten (ondemeer gewoon contract, werfreserve, vervangcontract, statutair,...)

Voor wie?

Iedereen die een door dPM (digitaal Partner Management) goedgekeurde partnership heeft afgesloten, mag de Referentie API gebruiken.

Vraag de Referentie API aan >

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

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

 

Voorbeeld: Arbeidsmarkt API met referentie-data voor 'arbeidsovereenkomst' voor gebruik bij vacature

API COE - Referentie API - Hoe testen - voorbeeld Arbeidsovereenkomst

 

API COE - Referentie API - Hoe testen - voorbeeld Arbeidsmarktovereenkomst 2

 

GET https://api.vdab.be/services/openservices/v1/arbeidsregimes

Headers:

Accept: application/json

X-IBM-Client-Id: ***

[

    {

        "code": "V",

        "beschrijving": "voltijds"

    },

    {

        "code": "D",

        "beschrijving": "deeltijds"

    }

]

 

GET https://api.vdab.be/services/openservices/v1/arbeidsstelsels

Headers:

Accept: application/json

X-IBM-Client-Id: ***

[

    {

        "code": "D",

        "beschrijving": "Dagwerk"

    },

    {

        "code": "N",

        "beschrijving": "Nachtwerk"

    },

    {

        "code": "2",

        "beschrijving": "2 ploegenstelsel"

    },

    {

        "code": "3",

        "beschrijving": "3 ploegenstelsel"

    },

    {

        "code": "V",

        "beschrijving": "Volcontinu systeem"

    },

    {

        "code": "Z",

        "beschrijving": "Weekend"

    },

    {

        "code": "O",

        "beschrijving": "Onderbroken dienst (service coupé)"

    },

    {

        "code": "DI",

        "beschrijving": "Dienstencheques"

    },

    {

        "code": "T",

        "beschrijving": "interesse tewerkstellingsmaatregel"

    },

    {

        "code": "U",

        "beschrijving": "ervaring als interimaris"

    },

    {

        "code": "P",

        "beschrijving": "deeltijds"

    },

    {

        "code": "ZE",

        "beschrijving": "Zelfstandige activiteit"

    },

    {

        "code": "NB",

        "beschrijving": "()"

    },

    {

        "code": "I",

        "beschrijving": "Interesse voor interim werk"

    }

]

 

GET https://api.vdab.be/services/openservices/v1/arbeidscontractduren

Headers:

Accept: application/json

X-IBM-Client-Id: ***

[

    {

        "code": "ONBEPAALD",

        "beschrijving": "onbepaalde duur"

    },

    {

        "code": "BEPAALD",

        "beschrijving": "bepaalde duur"

    }

]

 

GET https://api.vdab.be/services/openservices/v1/arbeidscontracten

Headers:

Accept: application/json

X-IBM-Client-Id: ***

[

    {

        "code": "CM",

        "beschrijving": "Collectief maatwerk"

    },

    {

        "code": "FS",

        "beschrijving": "Instapstage"

    },

    {

        "code": "LD",

        "beschrijving": "Lokale diensteneconomie"

    },

    {

        "code": "G",

        "beschrijving": "Gewoon contract."

    },

    {

        "code": "TW",

        "beschrijving": "tewerkstellingsmaatregel"

    },

    {

        "code": "OW",

        "beschrijving": "Occasioneel werk"

    },

    {

        "code": "VW",

        "beschrijving": "Vrijwilligerswerk"

    },

    {

        "code": "AP",

        "beschrijving": "Aanwerving met sterke voorkeur voor kandidaten die voldoen aan de voorwaarden voor het bekomen van een werkkaart."

    },

    {

        "code": "Q",

        "beschrijving": "Vervangingscontract brugpensioen - Voorwaarden: uitkeringsgerechtigd werkloos of schoolverlater in wachttijd zijn."

    },

    {

        "code": "GB",

        "beschrijving": "Beperkte tewerkstelling <13 uren/week"

    },

    {

        "code": "IN",

        "beschrijving": "informatie"

    },

    {

        "code": "I",

        "beschrijving": "Interimcontract."

    },

    {

        "code": "IV",

        "beschrijving": "Interim met optie 'vast werk'"

    },

    {

        "code": "MO",

        "beschrijving": "Middenstandsopleiding."

    },

    {

        "code": "OO",

        "beschrijving": "Ondernemingsopleiding."

    },

    {

        "code": "SB",

        "beschrijving": "jonger zijn dan 26 jaar en ingeschreven zijn als werkzoekende, geen studies met volledig leerplan meer volgen"

    },

    {

        "code": "WS",

        "beschrijving": "Werfreserve"

    },

    {

        "code": "V",

        "beschrijving": "Studentenjob."

    },

    {

        "code": "T",

        "beschrijving": "Tijdelijke job."

    },

    {

        "code": "GC",

        "beschrijving": "Gewoon contract (dienstencheques)"

    },

    {

        "code": "GA",

        "beschrijving": "Vacature uitsluitend voor personen met een arbeidshandicap ingevolge BVR 07-12-2007"

    },

    {

        "code": "GO",

        "beschrijving": "Vlaamse Overheid extra toeleiding kansengroepen"

    },

    {

        "code": "GD",

        "beschrijving": "Vacature voorbehouden voor deeltijds leerplichtigen"

    },

    {

        "code": "VU",

        "beschrijving": "Vaste job bij het uitzendkantoor"

    },

    {

        "code": "Z",

        "beschrijving": "Zelfstandige activiteit"

    },

    {

        "code": "E",

        "beschrijving": "Een aanwervingsexamen."

    },

    {

        "code": "U",

        "beschrijving": "Een aanwervingsexamen selor."

    },

    {

        "code": "DO",

        "beschrijving": "Duidelijk omschreven werk"

    },

    {

        "code": "VC",

        "beschrijving": "Vervangcontract"

    },

    {

        "code": "ST",

        "beschrijving": "Werk als statutair."

    },

    {

        "code": "3",

        "beschrijving": "Zeelieden (baz - Antwerpen)."

    },

    {

        "code": "D",

        "beschrijving": "Contract Derde Arbeidscircuit."

    },

    {

        "code": "DJ",

        "beschrijving": "Contract Derde Arbeidscircuit - Voorwaarden: minimum 1 jaar uitkeringsgerechtigd werkloos zijn."

    },

    {

        "code": "F",

        "beschrijving": "Vervangingscontract loopbaanonderbreking  privésector - Voorwaarden: o.a. uitkeringsgerechtigd werkloos zijn of schoolverlater. Meer info te bekomen op het nummer 070-34 50 00."

    },

    {

        "code": "GJ",

        "beschrijving": "gewoon contract, (de werkgever is sterk geïnteresseerd in werkzoekenden  met een JOBKAART)"

    },

    {

        "code": "H",

        "beschrijving": "Jeugdwerkgarantieplan."

    },

    {

        "code": "J",

        "beschrijving": "Jongerenbanenplan."

    },

    {

        "code": "K",

        "beschrijving": "Werkervaringsplan."

    },

    {

        "code": "L",

        "beschrijving": "Vervangingscontract loopbaanonderbreking openbare sector - Voorwaarden: o.a. uitkeringsgerechtigd werkloos zijn. Meer info te bekomen op het nr. 070-34 50 00."

    },

    {

        "code": "M",

        "beschrijving": "Voordeelbaan - Voorwaarden: in bezit zijn van een banenkaart, te bekomen bij de RVA."

    },

    {

        "code": "MI",

        "beschrijving": "MINA-contract - Voorwaarden: ocmw-uitkering genieten of minimum 2 jaar werkloos zijn."

    },

    {

        "code": "O",

        "beschrijving": "Gesco-contract."

    },

    {

        "code": "PC",

        "beschrijving": "WEP+vacature, voorbehouden voor langdurig werkzoekenden (inlichtingen bij je consulent of de VDAB-servicelijn)"

    },

    {

        "code": "S",

        "beschrijving": "Stage."

    },

    {

        "code": "W",

        "beschrijving": "Eerste werkervaringscontract."

    },

    {

        "code": "WE",

        "beschrijving": "Werkervaringsplan."

    },

    {

        "code": "X",

        "beschrijving": "Extra (horeca)"

    },

    {

        "code": "Y",

        "beschrijving": "Ingroeibaan."

    },

    {

        "code": "B",

        "beschrijving": "Dienstenbaan - Voorwaarden: minimum 2 jaar uitkeringsgerechtigd werkloos zijn. vanaf 45 jaar is 6 maanden uitkeringsgerechtigd werkloos zijn voldoende."

    },

    {

        "code": "AM",

        "beschrijving": "Arbeidszorg Meerbanenplan - voorwaarden: verplicht ingeschreven werkzoekende + opgenomen zijn in de doelgroep arbeidszorg na een activeringsscreening of -begeleiding met als advies arbeidszorg (werkgever moet attest hiervan opvragen bij VDAB)"

    },

    {

        "code": "AZ",

        "beschrijving": "Arbeidszorg (oude plaatsen) - voorwaarden: ingeschreven zijn als werkzoekende bij de VDAB +  opgenomen zijn in de doelgroep arbeidszorg door de VDAB op advies van ATB (attest hiervan is af te leveren door de VDAB op vraag van de werkgever)"

    },

    {

        "code": "GS",

        "beschrijving": "Gewoon contract, voorbehouden voor werkzoekenden, ouder dan 18 jaar, met een gekwalificeerde beroepsopleiding of een vergelijkbare beroepservaring."

    },

    {

        "code": "IB",

        "beschrijving": "Contract voor invoegbedrijf - Inlichtingen bij je consulent."

    },

    {

        "code": "KB",

        "beschrijving": "Gewoon contract, voorbehouden voor werkzoekenden die in aanmerking komen voor SINE. Inlichtingen bij je consulent."

    },

    {

        "code": "KG",

        "beschrijving": "Gewoon contract, voorbehouden voor werkzoekenden die in aanmerking komen voor SINE. Inlichtingen bij je consulent."

    },

    {

        "code": "BEVORD",

        "beschrijving": "Bevorderingen"

    },

    {

        "code": "HORIZMOB",

        "beschrijving": "Horizontale mobiliteit"

    },

    {

        "code": "EXTMOB",

        "beschrijving": "Externe mobiliteit"

    },

    {

        "code": "GRDVER",

        "beschrijving": "Graadverandering"

    },

    {

        "code": "HERPL",

        "beschrijving": "Herplaatsing"

    },

    {

        "code": "STAT",

        "beschrijving": "Statutair"

    },

    {

        "code": "CONTRACTONB",

        "beschrijving": "Contractueel onbepaalde duur"

    },

    {

        "code": "CONTRACTBEP",

        "beschrijving": "Contractueel bepaalde duur"

    },

    {

        "code": "STUDJOB",

        "beschrijving": "Studentenjobs"

    },

    {

        "code": "LP",

        "beschrijving": "Leerplek"

    },

    {

        "code": "STARTB",

        "beschrijving": "Startbanen / leerovereenkomsten"

    },

    {

        "code": "STAGES",

        "beschrijving": "Stages"

    },

    {

        "code": "MGMTJOB",

        "beschrijving": "Managementjobs"

    },

    {

        "code": "PMABJOB",

        "beschrijving": "Voorbehouden betrekking voor personen met een arbeidshandicap"

    },

    {

        "code": "TV",

        "beschrijving": "Tijdelijke job (met optie vast)"

    },

    {

        "code": "FL",

        "beschrijving": "Een flexijob is een bijverdienste en staat open voor iedereen die, reeds 3 kwartalen geleden, minstens 4/5 bij een andere werkgever, uit een andere sector, in vast dienstverband werkt."

    },

    {

        "code": "AL",

        "beschrijving": "Activa langdurig werkzoekenden"

    }

]