Loket.nl gaat volledig over naar RESTful API

Per 31 december 2020

Overgang naar RESTful API

Op 31 december 2020 wil Loket.nl volledig over zijn op RESTful API en vanaf 1 juli 2020 zullen wij onze huidige koppeling op basis van SOAP webservices ook niet meer onderhouden.

Veiligheid, performance en gebruikersgemak zijn voor Loket.nl belangrijke speerpunten. En daarom zijn wij continu in ontwikkeling. In het afgelopen jaar hebben wij hard gewerkt aan een compleet nieuwe architectuur op basis van RESTful API. We zijn nu zover dat nagenoeg alle functies van Loket.nl op deze wijze worden ontsloten.

Salarisadministratie voor werkgevers
Loket bijzonder jaar

Voordelen RESTful

Een overgang naar de Loket.nl RESTful API biedt jullie de volgende voordelen:

  • Verbeterde veiligheid op basis van OAuth2 standaard;
  • De Loket.nl RESTful API biedt veel bredere mogelijkheden voor het opzetten van integratie;
  • Objectgedreven op basis van RESTful API richtlijnen;
  • Autorisatie en controle zowel op gebruiker als client niveau;
  • Eenvoudige activatie van de koppeling op basis van de consent flow;
  • De Loket.nl RESTful API heeft een centrale positie in de architectuur van Loket.nl en is altijd actueel met de nieuwste features.

Naast het technische aspect is er ook het functionele aspect. De regelmatige veranderingen in Loket.nl, bijvoorbeeld de aanpassingen m.b.t. de Wet Arbeidsmarkt in balans (WAB) per 2020 en het journaliseren op basis van het nieuwe journaalprofiel, worden niet langer meegenomen in de SOAP webservices. Ook om de koppeling actueel te houden, zal de overstap gemaakt worden naar de RESTful API.

In 5 stappen over naar RESTful

Loonadministratie - Overstappen naar Loket.nl

Orienteer je op de technische informatie

Alle technische informatie over de RESTful api van Loket.nl vind je door op de button “informatie RESTful” te klikken.

Salarisadministratie - Overstappen naar Loket.nl

Vraag API testgegevens aan

Om zo snel mogelijk aan de slag te kunnen, vragen wij je om een mail te sturen naar api@loket.nl. Doe dit op de naam van de huidige webservicepartij. Wij voorzien je dan zo snel mogelijk van de juiste informatie.

Salarisadministratie - Overstappen naar Loket.nl

Ontwikkeling

Na het aanvragen van de client krijg je toegang tot:

  • Het ticketsysteem en het helpdeskportaal (als dat nog niet het geval was).
  • Een generieke API client en user op de testomgeving.

Hiermee kan je aan de slag met de ontwikkeling. Support zal geleverd worden via het ticketsysteem.

Overstappen naar Loket.nl

Overgang

Verlopen de werkzaamheden op de testomgeving succesvol en wil je overgang naar productie? Dien dan je aan aanvraag in.

Gezamenlijk kijken we vervolgens of alles werkt en klaar is voor productie. Zie ook aanvraag informatie koppelpartijen.

Loonadministratie - Overstappen naar Loket.nl

Inrichting productie gebruikers

De SOAP webservices maken gebruik van zogeheten ‘webservicegebruikers’. Deze aparte manier van werken zal echter op den duur volledig uitgefaseerd worden. Deze gebruikers zullen NIET werken in combinatie met de RESTful API.

De RESTful API maakt gebruik van ‘normale’ Loket.nl gebruikers en daarmee de bijbehorende authorisatie methodiek (o.b.v. OAuth2) . Met andere woorden gebruikers die ook in Loket.nl toegang hebben

Dit betekent dus dat de daadwerkelijke gebruikers die gebruikt worden in de koppeling andere gebruikers zal moeten betreffen dan voor de SOAP webservices. Houd hier rekening mee.

De inrichting en het gebruik van gebruikers ligt bij de accountants en of werkgevers zelf. Loket.nl zal op het helpdeskportaal informatie bieden waarmee accountants en/of werkgevers dus aanpassing in de gebruikersinrichting kunnen doorvoeren.

6

Overgang naar productie (REST API client)

Er zal bij productiegang een API client beschikbaar worden gesteld. In het kader van de privacy richtlijnen zullen alleen die activities worden vrijgegeven die nodig zijn voor het doel van de koppeling. Graag bij deze de lijst delen van alle activity names die gebruikt worden. Een voorbeeld van een activity name is GetEmployeesByEmployerId, alle activity names zijn te vinden op de developer portal).

Dit is de eerste activity en zo volgen er meer. 

Indien er sprake is van extra gevoelige informatie (denk hierbij aan het citizenServiceNumber) dan vragen we je om een extra toelichting te geven waarom dit noodzakelijk is voor het gebruik van de koppeling.

Alle technische informatie bekijken om over te stappen?