Met ingang van 2022 is de Nmbrs REST API live. Koppelingen met deze API worden gelegd op debiteurniveau middels een klantlogin (beschikbaar voor zowel het accountant- als businessproduct.. In dit artikel lichten we kort toe hoe dergelijke koppelingen gelegd kunnen worden en welke login hier voor nodig is.
- Overstap van SOAP naar REST
- Toegang verlenen aan andere applicaties
- Toegang verlenen vanuit meerdere debiteuren richting 1 applicatie
- Beheren van koppelingen op basis van REST
Overstap van SOAP naar REST
Met het ontwikkelen van een REST API maakt Nmbrs het mogelijk voor andere applicaties om op basis van deze technologie een koppeling te maken. Voor eindgebruikers, en in het speciaal klant logins, heeft dit bepaalde gevolgen. Onderstaande tabel geeft kort weer wat de belangrijkste verschillen zijn tussen een koppeling welke op basis van de Nmbrs SOAP API en REST API gebouwd zijn.
SOAP | REST |
API token verstrekken voor verlenen van toegang | Klant geeft zelf toestemming in de vorm van een consent pagina |
API calls activeren in het API user template | Ontwikkelaar van koppeling heeft vooraf bepaald voor welke data toegang verleend wordt |
Geen overzicht van lopende koppelingen | Voor de gebruiker zichtbaar welke koppelingen geactiveerd zijn in het 'gebruiker profiel' |
Toegang verlenen aan andere applicaties
Een groot voordeel van het gebruik van een REST-koppeling is het feit dat een Master Client login zelf toegang verleent tot de applicatie waar mee gekoppeld wordt. Zodra een gebruiker een bepaalde koppeling op het oog heeft, kan het koppelen worden gestart vanaf de te koppelen applicatie. Vervolgens zal met de inloggegevens van de Master Client login ingelogd moeten worden waarna onderstaande pagina verschijnt. Hier kan worden ingezien tot welke data de applicatie toegang krijgt zodra toestemming wordt verleend. Tot welke data toegang wordt verleend, wordt bepaald door de ontwikkelaar van de koppeling.
Let op: Om een REST-koppeling te activeren is het van belang dat de klant over een Master Client login of een Bedrijfslogin beschikt. In deze categorie vallen de volgende user templates:
- Alle scenario's Bedrijfslogin
- HR Manager (System) of (Scenario 3) General Manager Payroll & HR
Voor het aansluiten van een koppeling op basis van de REST API is het dus niet meer nodig om API calls in het API user template te activeren. Ook het delen van API-tokens is niet meer nodig. De authenticatie is ondergebracht in het hebben van een gebruikersaccount in de Nmbrs applicatie.
Toegang verlenen voor meerdere debiteuren richting 1 applicatie
Vanaf maart 2024 is het mogelijk om een koppeling te maken met de REST API vanuit meerdere Nmbrs debiteuren richting 1 applicatie. Hier is de vereiste dat er bij al deze debiteuren hetzelfde e-mailadres actief is en dat er minimaal één keer is ingelogd in de UI van Nmbrs met het profiel.
Hier wordt er door de gebruiker na het inloggen gekozen welke debiteuren mee moeten gaan in de koppeling. Dat ziet er als volgt uit:
Zo kan de gebruiker kiezen of er 1 of meerdere debiteuren moeten worden geselecteerd.
Beheren van koppelingen op basis van REST
Wanneer een REST-koppeling gelegd is, kan deze beheert worden in het gebruikersprofiel van degene die de koppeling gelegd heeft. In het gebruikersprofiel is de tab 'Manage apps' terug te vinden.
In de toekomst wordt het voor accountant logins ook mogelijk om een overzicht van alle koppelingen binnen de gehele omgeving in te zien!
Opmerkingen