Introductie
Loket biedt veilige en efficiënte gegevensuitwisseling met externe applicaties via een RESTful API. Deze handleiding beschrijft de stappen voor het opzetten van een koppeling, inclusief gebruikersbeheer, consent flow en technische documentatie.
Hoe werkt het?
1. Aanmaken van een gebruiker
Voor een koppeling is een Loket-gebruiker nodig:
- Bij voorkeur op werkgeverniveau (niet op providerniveau), om datalekken tussen werkgevers te voorkomen. Bij gebruikers op providerniveau is er sprake van een team waaronder meerdere werkgevers kunnen hangen welke mogelijk niets met elkaar te maken hebben.
- Geen webservicegebruiker, maar een normale gebruiker die uitsluitend voor de koppeling wordt gebruikt.
- De gebruiker moet actief en niet geblokkeerd zijn.
- De gebruiker moet toegang hebben tot de juiste werkgever.
- Rechten afhankelijk van de koppeling. Zie: Een koppeling? Deze rechten heb je nodig · Loket.nl
Gebruik van bestaande gebruiker:
Een bestaande gebruiker mag worden gebruikt, mits deze voldoet aan de voorwaarden. Een aparte gebruiker is echter aan te raden voor overzicht en continuïteit (bijvoorbeeld bij uitdiensttreding).
2. Consent flow (OAuth)
De consent flow is een veilige methode om een derde partij toegang te geven tot specifieke gegevens:
- De derde partij leidt je naar de Loket.nl consentpagina.
- Je logt in met de Loket-gebruiker die voor de koppeling is bedoeld.
- Je ziet welke gegevens worden opgevraagd.
- Je geeft toestemming.
- Je wordt teruggeleid naar de externe applicatie.
3. Activities / Endpoints
Endpoints zijn gegevensgroepen zoals dienstverbanden, loonruns en arbeidstijd. Elke koppeling heeft toegang tot specifieke endpoints:
- Rechten van de gebruiker bepalen wat zichtbaar is.
- Alleen vrijgegeven endpoints worden gebruikt in de koppeling.
- We raden aan om alleen noodzakelijke rechten te geven.
4. Developer portal
Technische documentatie is beschikbaar via het Loket.nl Developer Portal:
- Uitleg over autorisatie en consent flow.
- Overzicht van beschikbare endpoints.
- Veelgestelde vragen en foutmeldingen.
Handig om te weten
- Bij sommige koppelingen (zoals ASR via BenefitsPlaza of VCSW/De Goudse) is een gebruiker op providerniveau vereist vanwege extra validatie op Werkgever.
- Loket heeft geen inzicht in de werkwijze van externe partijen; zorg dus voor correcte inrichting aan jouw kant.
- Gebruikersbeheer en rechten zijn de verantwoordelijkheid van de accountant en/of werkgever.
Contact: api@loket.nl
Voor vragen over API-koppelingen kun je contact opnemen via api@loket.nl.