Hoe verloopt de voorbereiding (onboarding) als je wil starten met API's?
Op deze pagina vind je alles wat je moet weten om te starten met het automatisch uitwisselen van data via API's van VDAB. Lees hoe je toegang krijgt tot de VDAB API’s en welke stappen je moet doorlopen bij de technische voorbereiding met uitgebreide testfase.
De API's die VDAB aanbiedt kan je onderscheiden in API's waarmee je automatisch gegevens:
- bij VDAB afneemt.
- of naar VDAB doorstuurt.
Starten met API's om data af te nemen
1. Kennismaking en samenwerkingsovereenkomst
Als je een aanvraag indient bij het API Center of Excellence (CoE) om met een API om data af te nemen, organiseren wij een kort kennismakingsgesprek met jou om je noden goed te begrijpen.
Verloopt dat gesprek positief, dan stellen we, waar nodig, een samenwerkingsovereenkomst op. Nadat je deze samenwerkingsovereenkomst hebt ondertekend, kan je toegang aanvragen tot de gewenste API's.
2. Toegang aanvragen tot de gewenste API's
Wie vraagt toegang aan?
We vragen uitdrukkelijk dat jij als eindklant zelf deze toegang aanvraagt en de softwareleverancier waarmee je eventueel samenwerkt. Waarom? Je bent als eindklant contractueel verantwoordelijk voor het correct gebruik van de API. Daarom moet je de toegang zelf aanvragen.
Hoe toegang aanvragen?
Na het positieve kennismakingsgesprek en waar nodig, ondertekening van samenwerkingsovereenkomst, bezorgen we je een link om:
- eerst je eigen account te activeren
- vervolgens je toepassing te registreren
- daarna het abonnement op de gewenste API aan te vragen
Wij verwerken je aanvraag en beslissen of de koppeling tussen de gewenste API en de geregistreerde applicatie mag plaatsvinden. Als dat het geval is, ontvang je als eindklant een mail met de melding dat de toegang tot de API in orde is.
Handleiding
In deze handleiding lees je in detail hoe je als eindklant toegang aanvraagt tot de VDAB APi's door op het Ontwikkelaarsportaal eerst je eigen account te activeren, vervolgens je toepassing te registreren en het abonnement op de gewenste API aan te vragen.
Starten met API's om vacatures te publiceren
1. Kennismaking en samenwerkingsovereenkomst
Als je een aanvraag indient bij het API Center of Excellence (CoE) om te starten met het automatisch publiceren van vacatures via de Vacature Posting API (service) op vdab.be, gaan we met jou in gesprek over:
- de technische voorbereiding die nodig is voor de technische implementatie van deze API
- de verschillende stappen van de onboarding.
Verloopt dit gesprek positief, dan onderteken je een contract samenwerkingsovereenkomst en start de onboarding.
Bekijk de samenwerkingsovereenkomst:
2. Onboarding met testfase: 5 stappen
In deze afbeelding zie je de 5 verschillende stappen met een uitgebreide testfase die je moet doorlopen om deze voorbereiding succesvol te doorlopen. We beschrijven ze verder gedetailleerd.
Stap 1: testcredentials
Zodra je de samenwerkingsovereenkomst voor de aanvraag van een API ondertekend hebt, ontvang je binnen de 5 werkdagen de vereiste testcredentials om de nodige testen te kunnen uitvoeren.
Wanneer je samenwerkt met een softwareleverancier voor de implementatie van de API, bezorgen we de informatie ook aan hen.
Stap 2: technische testen
Jij voert de technische testen uit, waarbij je nagaat of:
- je credentials werken
- je de API kan oproepen
- je een HR-XML bestand kan doorsturen naar VDAB en VDAB dat bestand ook correct ontvangt.
- enzovoort
Werk je voor de implementatie van de API samen met een softwareleverancier? Dan is deze verantwoordelijk voor de uitvoering van de technische testen.
Stap 3: maturiteitstesten met testvacatures
Zodra de connectie met VDAB correct opgezet is, kan je een aantal realistisch opgestelde testvacatures doorsturen. Dit kunnen eigen testvacatures, oude of bestaande productievacatures zijn.
Hoe?
Je stuurt 5 à 10 testvacatures door naar de testomgeving en geeft een seintje aan api.coe@vdab.be.
Wanneer?
Testen met testvacatures doe je bij voorkeur binnen de 15 dagen nadat je de testcredentials hebt ontvangen.
Doe je dat niet binnen die termijn, dan zal het API CoE je een herinnering sturen om de testfase zo snel mogelijk te starten.
Stap 4: feedback op uitgevoerde testen
Als de testvacatures kwalitatief niet voldoen, ontvang je van ons:
- feedback met verbetervoorstellen
- de vraag om nieuwe en/of aangepaste testvacatures aan te leveren.
Je doorloopt een nieuwe testcyclus tot de testvacatures het vereiste kwaliteitsniveau behalen.
Zodra de testvacatures voldoen aan de kwaliteitsnormen brengen we je hiervan op de hoogte.
Idealiter 3 maanden testen
Idealiter duurt de testfase maximaal 3 maanden. Wordt de periode van 3 maanden overschreden, dan nemen wij contact met je op om na te gaan:
- waarom je de testfase niet tijdig hebt afgerond
- of je de implementatie wil verderzetten:
- Wil je doorgaan, dan willen wij graag weten binnen welke termijn je de testfase kan afronden.
- Wil je stopzetten, dan willen wij graag weten waarom.
Stap 5: productiecredentials
Ten slotte ontvang je binnen de 5 werkdagen na het succesvol beëindigen van de testfase de nodige productiecredentials om je vacatures te publiceren op vdab.be.
Infofiche
In deze infofiche vind je in detail de onboarding voor de Vacature Posting API.