Handleiding REST API koppeling

Volgen

Dit artikel omvat een beknopte generieke uitleg om te koppelen met de Loket.nl REST API.

Welke gebruiker is nodig voor een REST API koppeling

  • De gebruiker moet een nieuwe standaard Loket.nl gebruiker zijn (nadrukkelijk geen webservicegebruiker) die speciaal wordt aangemaakt voor de koppeling en nergens anders voor wordt gebruikt.
  • De gebruiker moet actief zijn (niet geblokkeerd).
  • De gebruiker moet toegang hebben tot de werkgever. Dit kan door middel van teams of door de gebruiker direct bij de werkgever aan te maken.
  • De gebruiker moet de juiste rechten hebben, individueel of via het team. Deze rechten verschillen per koppeling. De juiste rechten kan je vinden in het artikel Rechten bestand RESTful API koppelingen

Aanvullende zaken

  • Het kan voorkomen dat er in de administratie een exportset aangemaakt dient te worden, bijv. bij Werktijden.nl.
  • Indien er sprake is van een AK-gebruiker ofwel provider gebruiker dan heeft deze toegang tot alle werkgevers welke zijn toegevoegd aan het Team. Indien het werkgevers zijn die niets met elkaar te maken hebben dan raden we aan om een WG-gebruiker (werkgevergebruiker) aan te maken. Dit is een extra voorzorgsmaatregel om te voorkomen dat onbedoeld gegevens van werkgever A inzichtelijk zijn voor werkgever B. In principe is dit afgedekt aan de kant van de koppelpartij maar Loket.nl heeft geen inzicht en rechten over de werkwijze van een externe partij.
  • Een (reeds bestaande) SOAP webservicegebruiker is niet bruikbaar voor de REST API koppeling.
  • Gebruikersbeheer en het toekennen van rechten is aan de accountant en/of de werkgever.
  • Het eenmalig toestemming geven voor gebruik koppeling loopt via de consent flow.

Voor overige informatie omtrent het koppelen kun je het beste contact opnemen met de REST API koppelpartij.

 

Extra: nieuwe gebruiker versus bestaande gebruiker

Het is prima mogelijk om een reeds bestaande Loket.nl gebruiker te gebruiken ten behoeve van een API koppeling, zolang deze maar voldoet aan de gestelde voorwaarden.

In de praktijk zien we echter vaak dat men er voor kiest een aparte gebruiker aan te maken t.b.v. een koppeling. Dit heeft als voordeel dat dit dan meer inzichtelijk is voor de gebruikersbeheerder. Het komt dan bijvoorbeeld minder vaak voor dat een koppeling onbedoeld zijn toegang verliest.

Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 2 van 4