Hoe verloopt de voorbereiding (onboarding) als je wil starten met API's?
Je leest op deze pagina alles wat je moet weten als je API's van VDAB wil gaan gebruiken. We beschrijven de verschillende stappen van de technische voorbereiding met een uitgebreide testfase (onboarding) die je moet doorlopen om effectief te kunnen starten met het automatisch uitwisselen van data via API's van VDAB.
De API's die VDAB aanbiedt kan je onderscheiden in API's waarmee je automatisch gegevens:
- bij VDAB ophaalt.
- of naar VDAB doorstuurt.
Starten met API's om data af te nemen
Als je een aanvraag indient bij het API Center of Excellence (CoE) om te starten met een API om data af te nemen, organiseren wij een kort gesprek met jou om je noden goed te begrijpen.
Verloopt dat gesprek positief, dan bezorgt het CoE 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
Het CoE verwerkt je aanvraag en beslist of de koppeling tussen de gewenste API en de geregistreerde applicatie mag plaatsvinden.
Als dat het geval is, ontvang je een mail met de melding dat de toegang tot de API in orde is.
Handleiding
In deze handleiding lees je hoe je toegang krijgt tot de VDAB APi's door op de Developer Portal eerst je eigen account te activeren, vervolgens je toepassing te registreren en het abonnement op de gewenste API aan te vragen.
Developer Portal (Ontwikkelaarsportaal)
Starten met API's om vacatures te publiceren
Als je een aanvraag indient bij het API Center of Excellence (CoE) om te starten met het automatisch publiceren van vacatures via API’s op vdab.be, organiseren wij een gesprek met jou om je te informeren over de technische voorbereiding die nodig is bij het opzetten van de API. Verloopt het gesprek positief, dan onderteken je een contract en start de voorbereiding.
Als je samenwerkt met een servicebedrijf voor het opzetten van de API regelen wij dit rechtstreeks met het servicebedrijf.
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.
5 stappen
Stap 1: test credentials
Zodra je het contract voor de aanvraag van een API ondertekend hebt, ontvang je binnen de 5 werkdagen de vereiste test credentials om de nodige testen te kunnen uitvoeren
Deze informatie bezorgen we aan jou, en wanneer je samenwerkt met een derde partij voor het opzetten van de API, bezorgen we deze informatie ook aan hen. Een derde partij kan een multiposter of een servicebedrijf zijn.
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 het opzetten van de API samen met een derde partij? Dan is deze verantwoordelijk voor de uitvoering van de technische testen.
Stap 3: maturiteitstesten met test-vacatures
Zodra de connectie met VDAB correct opgezet is, kan je een aantal realistisch opgestelde test-vacatures doorsturen. Dit kunnen eigen testvacatures, oude of bestaande productie-vacatures zijn.
Hoe?
Je stuurt 5 à 10 testvacatures door en geeft een seintje aan api.coe@vdab.be.
Wanneer?
Testen met test-vacatures doe je bij voorkeur binnen de 15 dagen nadat je de test credentials hebt ontvangen.
Doe je dat niet binnen die termijn, dan zal het Centre of Excellence je een herinnering sturen om de testfase zo snel mogelijk te starten.
Stap 4: feedback op uitgevoerde testen
Als de testvacatures niet voldoen, ontvang je van ons:
- feedback, waar nodig vergezeld van verbetervoorstellen
- de vraag om nieuwe en/of aangepaste testvacatures aan te leveren.
Je doorloopt een nieuwe test-cyclus tot de test-vacatures het vereiste kwaliteitsniveau behalen.
Zodra de testvacatures voldoen aan de VDAB 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: productie credentials
Ten slotte ontvang je binnen de 5 werkdagen na het succesvol beëindigen van de testfase de nodige productie credentials om je vacatures te publiceren op de vdab.be.
Servicebedrijven
Infofiche
In deze infofiche vind je in detail de onboarding voor de Vacature Posting API.