API: Gebruikerssjabloon
Er zijn API-templates beschikbaar om de toegangsrechten tot bepaalde API-aanroepen (calls) te beperken. Deze templates kunnen door de beheerder worden aangepast via de dashlet 'Template Users' op instellingenniveau. Met deze templates heeft een API-gebruiker alleen toegang tot de specifieke aanroepen die de klant toestaat.
De beheerder is verantwoordelijk voor het beheer van de toegangsrechten voor deze API-aanroepen. De integratiepartner is verantwoordelijk voor de communicatie met de klant over de beperking van de API-aanroepen. Het voordeel van de API-template is dat alle templates op maat gemaakt kunnen worden. We adviseren ten zeerste om elke template te vernoemen naar de integratie of de klant, en om voor elke integratie een nieuwe template aan te maken om het overzicht te bewaren.
Vereisten
Om API-templates in te richten is een accountant-login vereist. Deze accountant-login moet schrijfrechten hebben op de dashlet 'Template Users'.
Wat is de functionaliteit van de API-template?
De API-templates (op accountant- en bedrijfsniveau) zijn standaard vooraf geactiveerd met volledige rechten. Dit betekent dat de beheerder de rechten handmatig moet beperken als zij of hun klant willen dat de API-gebruiker aangepaste rechten krijgt. De API-aanroepen kunnen worden beperkt op het niveau van Employee Services, Company Services en Debtor Services. De beheerder kan de API-aanroepen beperken door ze op actief of inactief te zetten (zie de screenshot hieronder). Nadat een API-aanroep op actief of inactief is gezet, is dit direct van toepassing op de gebruikersaccounts die aan het desbetreffende template zijn gekoppeld.


Wanneer een API-aanroep op inactief is gezet, ontvang je de foutcode: "1002 Unauthorized Access". Dit betekent dat je niet over voldoende toegangsrechten beschikt voor deze API-aanroep. De accountant-beheerder moet dit beoordelen en beslissen of je meer toegangsrechten krijgt.
Integratiescenario's
Ongeacht het type integratie dat je bouwt, moet je een aantal beslissingen nemen voordat je met Cash Payroll integreert. Cash Payroll is een salarisrelevante applicatie met een eigen structuur en logica. Zorg ervoor dat je de verschillende niveaus begrijpt en weet dat er verschillende integratiescenario's zijn met de bijbehorende API-aanroepen. Klik hier voor informatie over integratiescenario's!