Dit document beschrijft de inrichting voor de klanten van Personeel & Salaris van de web api voor de koppeling met Werktijden.nl.
Voorwaarden api
De web api van HR & Salarisgemak is uitsluitend beschikbaar op de Salaris Cloud. Klanten die on-premise werken kunnen hier geen gebruik van maken.
Mogelijkheden api
De web api van HR & Salarisgemak is ontwikkeld om derde partijen de mogelijkheid te bieden te communiceren met de database van HR & Salarisgemak met zo min mogelijk gebruikershandelingen. Dit gaat om zowel lezen als schrijven.
Koppeling in HR & Salarisgemak
Om een koppeling te realiseren met een externe partij dient de klant hier zelf expliciet toestemming voor te geven binnen HR & Salarisgemak. Dit staat los van het contract en de verwerkersovereenkomst die de klant moet afsluiten met de externe leverancier. Hier is Unit4 geen partij in.
Activeren menu Web Api
Autorisatie instellen
Maak een nieuwe gebruiker aan
Maak een gebruikersgroep aan
Koppel de werkgever(s) aan de gebruikersgroep
Aanmaken van een web api gebruiker
1. Activeren menu Web Api
De functionaliteit om de web api te autoriseren is opgenomen in de nieuwe schermen van Toegangsbeheer. Om deze te activeren moeten eenmalig de volgende stappen worden ondernomen:
Log in met ‘Systeem’ rechten, in de meeste gevallen is dit de gebruiker .01
Ga naar Onderhoud | Systeembeheer | Toegangsbeheer
Ga naar het tabblad Menu
Selecteer het beheermenu of het systeemmenu.
Klik de boomstructuur bij het menu ‘Onderhoud Nieuw’ open
Activeer het onderdeel Onderhoud Nieuw, Systeembeheer en Toegangsbeheer, indien hier nog een rood kruis voor staan. Aan de rechterkant (onderin) kun je vervolgens een vinkje zetten bij ‘beschikbaar’ in de optie in het menu te activeren
Klik op Opslaan bij de geselecteerde menu opties om de wijzigingen te bevestigen.
Nu heeft iedere gebruiker met de ‘Beheer’ rechten toegang tot het autoriseren van een web api connectie. Om dit te activeren dien je HR & Salarisgemak opnieuw op te starten met de juiste gebruiker.
2. Autorisatie instellen
De toegang tot de Web API van HR & Salarisgemak gaat via U4IDS (Unit4 Identity Services). Per verbinding (klant) is een Client ID en een Client Secret nodig om toegang te verlenen. In de ClientID gegevens is vastgelegd waar de verbinding naartoe wordt gelegd en deze is gekoppeld aan een gebruiker in HR & Salarisgemak. In HR & Salarisgemak is een gebruiker gekoppeld aan een zogenaamde groep. Per groep kunnen werkgevers worden gekoppeld. Zo bestaat de mogelijkheid om voor iedere werkgever een andere gebruiker aan te maken met een eigen groep.
3. Maak een nieuwe gebruiker aan
Allereerst moet er een gebruiker worden aangemaakt ten behoeve van de API autorisatie. Voor dienstverlenende bedrijven, moet per werkgever/klant een gebruiker worden aangemaakt.
Om een gebruiker aan te maken volg je de volgende stappen:
Login met ‘Beheer’ rechten, in de meeste gevallen is dit gebruiker .01
Ga naar Onderhoud | Systeembeheer | Toegangsbeheer
Kies het tabblad Gebruikers
Kies Nieuw
Zorg dat de nieuwe gebruiker het niveau van Gebruiker heeft.
Sla de gegevens op.
4. Maak een gebruikersgroep aan
De volgende stap is om een gebruikersgroep aan te maken zodat alleen toegang kan worden gegeven op de geautoriseerde administratie. Voor dienstverlenende bedrijven, moet per werkgever/klant een gebruikersgroep worden aangemaakt.
Om een gebruikersgroep aan te maken volg je de volgende stappen:
Login met ‘Systeem’ rechten, in de meeste gevallen is dit gebruiker .01
Ga naar Onderhoud | Systeembeheer | Toegangsbeheer
Kies het tabblad Gebruikersgroepen
Kies Nieuw
Zorg dat de gebruiker die is aangemaakt bij stap 3 is gekoppeld aan deze nieuwe groep.
Sla de gegevens op.
5. Koppel de werkgever(s) aan de gebruikersgroep
Nu de nieuwe gebruikersgroep is aangemaakt, is de laatste stap om de werkgever(s) te koppelen waar de api koppeling voor van toepassing is.
Om werkgever(s) te koppelen aan de gebruikersgroep volg je de volgende stappen:
Login met ‘Systeem’ rechten, in de meeste gevallen is dit gebruiker .01
Ga naar Onderhoud | Systeembeheer | Toegangsbeheer
Kies het tabblad Autorisatie Werkgevers
Kies de gebruikersgroep die zojuist is aangemaakt bij stap 4
Koppel de werkgever die moet worden geautoriseerd door die naar rechts te verplaatsen
Sla de gegevens op
6. Aanmaken van een web api gebruiker
Om de leverancier toegang te verlenen moeten de volgende stappen worden gevolgd:
Log in met ‘Beheer’ rechten, in de meeste gevallen is dit gebruiker .01
Ga naar Onderhoud Nieuw | Systeembeheer | Toegangsbeheer
Kies het tabblad Web API gebruiker
Selecteer de externe applicatie
De lijst met externe applicaties wordt onderhouden door Unit4. Hierin staan alleen de applicaties die formeel zijn aangemeld en die voor alle klanten van toepassing zijn.Kies Nieuw om een gebruiker te selecteren.
Selecteer de bij punt 3 de aangemaakte gebruiker (Gebruiker)
Het veld Client ID en Client Secret (de identificatiecode voor Unit4 Identity Management), worden gegenereerd door te kiezen voor ‘Gebruik onderstaande knop om de code op te halen’
De wijzigingen worden automatisch opgeslagen als het Client Secret is ontvangen.
De gegenereerde Client ID en Client Secret kun je vervolgen invoeren tijdens het installeren van de app via het App Center.