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. 

Welke referentie-data?

We lijsten ze hieronder thematisch op:

Arbeidsovereenkomst

Arbeidsmarkt

  • (zie voorbeeld bij 'Hoe testen?'), geeft informatie over de arbeidsovereenkomst, met name de beschrijvingen en codes van:
    • arbeidsstelsels/tijdsregeling (bijv. voltijds, deeltijds)
    • arbeidsregimes (bijv. dagwerk, nachtwerk, volcontinu, 2 ploegenstelsel,...)
    • arbeidscontractduren (bijv. bepaalde, onbepaalde duur)
    • arbeidscontracten (bijv. vaste job, interimcontract, flexijob, …)

Plaats

Locaties

  • Geeft de verschillende regio’s en hun respectievelijke codes.
  • Bijvoorbeeld
    • BE234B - regio Gent
    • BE23 - Provincie Oost-Vlaanderen

VDAB-locaties

  • Geeft informatie over VDAB-locaties met o.a. adres, openingsuren voor de lopende week, ...

Taal

Taal

  • Geeft de beschrijvingen van talen en hun respectievelijke codes.
  • Bijvoorbeeld:
    • F - Frans
    • D - Duits

Taalniveaus in 6-puntenschaal

  • Geeft de codes en beschrijvingen van 6 verschillende taalniveaus.
  • Bijvoorbeeld:
    • 12 - Basis (A2)
    • 15 - Zeer goed (B2/C1/C2)

Taalniveaus in 4-puntenschaal

  • Geeft de codes en beschrijvingen van 4 verschillende taalniveaus. Dit is de schaal van taalniveaus die vroeger gebruikt werd. Gebruik vanaf nu de 6-puntenschaal te gebruiken.

Studies

Diploma’s

  • Geeft beschrijvingen en codes van getuigschriften en diploma's binnen de verschillende onderwijsniveaus en studiedomeinen.
  • Bijvoorbeeld:
    • MAA4IKK - Master Interieurarchitectuur
    • TBG4PGP - BSO 2de graad Verzorging
  • Te gebruiken in combinatie met de Vacature API en Profiel API

Studieboom

  • Geeft beschrijvingen en codes van studies, getuigschriften en diploma's binnen de verschillende onderwijsniveaus en studiedomeinen.
  • Niet te gebruiken in combinatie met de Vacature API en Profiel API: gebruik daarvoor 'Diploma’s'.

Diplomaniveau

  • Geeft enkel de niveaus van diploma’s en studies en hun respectievelijke codes, zonder verdere specificaties
  • Bijvoorbeeld:
    • B - Lager Onderwijs
    • F - Graduaat / HBO5

Attesten en rijbewijzen

Attesten

  • Geeft de beschrijvingen van attesten en hun respectievelijke codes
  • Bijvoorbeeld:
    • 10209 - Attest zorgkundige (VDAB)
    • 633 - Certificaat basisveiligheid VCA

Rijbewijs

  • Geeft de beschrijvingen van rijbewijzen en hun respectievelijke codes.
  • Bijvoorbeeld:
    • C1  - Kleine vrachtwagen htm < 7,5 ton
    • D  - autobus/autocar > 8 zitplaatsen en aanhangwagen max 750 kg

Beroepsdata

Sjablonen

  • Geeft de beschrijvingen en codes van beroepen gebruikt binnen Competent 1.
  • Bijvoorbeeld:
    • A110101-1  - Bestuurder van land- en bosbouwmachines
    • J150601-1 - Verpleegkundige

Competenties

  • Geeft de beschrijvingen en codes van alle jobgerelateerde competenties binnen Competent 1.
  • Bijvoorbeeld:
    • 236 - Informatie binnen een domein behandelen: Wetenschappen
    • 26200 - Informatie, berichten of teksten vertalen

Softskills

  • Geeft de beschrijving en codes van softskills.
  • Bijvoorbeeld:
    • 7 - Samenwerken om tot een gezamenlijk resultaat te komen
    • 50 -  Ontleden van een probleem en aanvullende informatie zoeken

Jobdomeinen

  • Geeft de beschrijvingen en codes van alle jobdomeinen (vergelijkbaar met indeling in sectoren)
  • Bijvoorbeeld:
    • JOBCAT14 - Dienstverlening
    • JOBCAT03 Bouw, JOBCAT08 - Horeca en toerisme

Andere

Onderwijs

  • Geeft de beschrijvingen en codes van onderwijsgraden en onderwijsvakken van toepassing op de onderwijsambten
  • Bijvoorbeeld:
    • Onderwijsgraad:
      • 04260 - Leerkracht 3de graad secundair onderwijs ASO-KSO-TSO
    • Onderwijsvak:
      • 04100 - Aardrijkskunde

Sollicitatievoorkeuren

  • Geeft de beschrijvingen en de codes van sollicitatievoorkeuren die werkgevers kunnen meegeven.
  • Bijvoorbeeld:
    • Z-brief
    • T - telefoon

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.