API Documentatie

Wil je meer informatie over onze beschikbare API? In dit artikel lichten we toe waar je deze kan vinden. Zo kan je binnen no-time beginnen met tegen onze API aan ontwikkelen!

Algemene toelichting #

Onze API documentatie is publiekelijk toegankelijk via de volgende link: api.staff.nl

Zoals je in de documentatie kan lezen is er recht (een API key) nodig om ook daadwerkelijk calls te kunnen maken. Deze key geeft Staff uiteraard niet zomaar weg, hiervoor heb je een account nodig waarmee je houw API key kunt genereren. Je vind jouw API key terug in de backoffice applicatie op pagina Mijn profiel.

Mijn profiel tbv genereren API key

Wil je calls kunnen doen op onze API en heb je dus een API key nodig en je hebt nog geen account? Neem dan contact op met support@staff.nl en geef een uitgebreide omschrijving en daarmee verantwoording van jouw intenties met de API en wie jouw opdrachtgever is. Wij nemen dan contact met jou op.

Vragen #

Als je vragen hebt over de API is dat geen probleem. Met alle redelijkheid zijn één of twee vragen altijd toegestaan zonder dat hier kosten tegenover staan. Blijven de vragen komen? Dan zullen mijn collega’s aangeven dat dit nu te veel tijd gaat kosten en zal er besproken worden of hier project(je) voor nodig is waarbij de bestede tijd zal worden doorbelast.

BI / Externe programmatuur #

Wil je calls doen t.b.v. BI of andere externe programmatuur die je aan het ontwikkelen bent? Neem dan eerst contact op met jouw accountmanager binnen Staff. Deze oplossing moet in dat geval gepitcht worden alvorens hier API keys voor verstrekt worden. Bij akkoord vanuit Staff krijg je toegang tot de API op onze ontwikkelomgeving om de oplossing te bouwen en te testen. Aan dit testaccount zijn kosten verbonden, gezien de support die hier uit voort kan / zal vloeien. Deze kosten zijn n.a.v. de meeting n.t.b.

Klaar met bouwen, en nu? #

Ben je klaar met bouwen en wil je de oplossing nu implementeren? Neem dan contact met ons op via ontwikkeling@staff.nl, we plannen dan een moment in om de oplossing door te nemen. Staff moet namelijk op zijn minst nalopen hoeveel data er wordt opgehaald en met welke frequentie dit gebeurd. Deze audit kan via Teams en kan daarom vaak op relatief korte termijn worden gepland.

Is de oplossing na onze audit akkoord? Dan krijg jij van ons een API voor de productie omgeving en kan jouw oplossing live!