Dit artikel bevat alle informatie over een Nmbrs integratie in Dialog, wat deze integratie mogelijk maakt, en wat er nodig is om deze integratie op te zetten. We hebben dit beschreven in drie stappen.
Stap 1: Integratie opzetten
De Nmbrs integratie in Dialog maakt gebruik van de Nmbrs XML SOAP webservices. Voor het opzetten van de integratie moeten er aan beide kanten een aantal stappen worden gezet.
1.1: API Credentials genereren & endpoints openzetten
De Nmbrs beheerder genereert API credentials waarmee Dialog de API kan aanroepen. De Nmbrs beheerder stuurt uiteindelijk de volgende informatie terug naar integrations@dialog.nl.
1.1.1: Aanmaken API Token
Maak een API token aan. Een gedetailleerde handleiding voor het aanmaken van een API token is te vinden op de volgende url: https://support.nmbrs.nl/hc/nl/articles/115003926251
1.1.2: Openzetten API endpoints
Dialog maakt gebruik van de volgende API endpoints. Deze moeten worden opengezet voor de API user zodat Dialog informatie kan ophalen.
- DebtorService - List_GetAll
- DebtorService - Department_GetList
- DebtorService - Function_GetList
- CompanyService - List_GetAll
- EmployeeService - List_GetByCompany
- EmployeeService - PersonalInfo_GetAll_AllEmployeesByCompany
- EmployeeService - Employment_GetAll_AllEmployeesByCompany
- EmployeeService - Department_GetAll_AllEmployeesByCompany
- EmployeeService - Department_GetAll_AllEmployeesByCompany
- EmployeeService - Function_GetAll_AllEmployeesByCompany_V2*
- EmployeeService - EmployeeDocument_UploadDocument
*In Nmbrs kunnen functies op globaal niveau en op debiteur niveau worden aangemaakt. Nmbrs biedt echter alleen de mogelijkheid om de functies op debiteur niveau op te halen. Indien dit niet het geval is, kan Dialog geen functie gegevens ophalen.
1.2: API Credentials verzamelen
De Nmbrs beheerder verzamelt de gegevens waarmee Dialog de API kan aanroepen. De Nmbrs beheerder stuurt uiteindelijk de volgende informatie terug naar integrations@dialog.nl.
| API Token | Vul hier de inhoud van de API token in |
| Username | Vul hier het emailadres in van de gebruiker die de API token heeft aangemaakt |
| Domain | Vul hier de naam in van het Nmbrs domain (bijv. als je Nmbrs url: dialog.nmbrs.nl is, dan is je domain: dialog) |
1.3: Testen en Activeren
Dialog activeert de koppeling met de aangeleverde API credentials en test of de koppeling werkt. Bij problemen wordt er direct contact opgenomen met de Nmbrs beheerder die de gegevens heeft gestuurd.
1.4: Importeren in Dialog
De Dialog beheerder van de klant kan nu de gebruikers, functies en afdelingen importeren en uitnodigen op het integratie scherm.
Stap 2: Importeren van gegevens
Dialog maakt het mogelijk om Nmbrs gebruikers, functies en afdelingen op te halen zodat deze snel en eenvoudig kunnen worden geïmporteerd. Hiervoor maakt Dialog gebruik van de volgende SOAP webservices: DebtorService, CompanyService en EmployeeService.
2.1 Gebruikersgegevens
Om gebruikers te importeren in Dialog hebben we een aantal velden nodig. Deze velden kunnen worden teruggevonden in de EmployeeService in een PersonalInfo, Employment, EmployeeDepartmentItem en EmployeeFunctionItem object. In de onderstaande opsomming is te zien welke gegevens van de EmployeeService Dialog gebruikt.
PersonalInfo:
- EmployeeId
- Nickname
- Lastname
- EmailWork
Employment:
- EmployeeId
- StartDate
- EndDate
EmployeeDepartmentItem:
- EmployeeId
- Code
- CreationDate
EmployeeFunctionItem**:
- EmployeeId
- Function.Id
- CreationDate
**Er bestaan situaties in Nmbrs dat medewerkers gekoppeld zijn aan globaal gedefinieerde functies. Dialog haalt alleen de functies op die op Debiteur niveau zijn gedefinieerd. Het kan in dat geval dus voorkomen dat Dialog niet alle functies van de medewerker ‘herkent/weergeeft’. Om dit goed te laten werken in Dialog, zullen globaal gedefinieerde functies dus op Debiteur niveau moeten worden toegevoegd.
2.2: Functie- en afdelingsgegevens
Om functies en afdelingen te importeren in Dialog hebben we een aantal velden nodig. Deze velden kunnen worden teruggevonden in de DebtorService in een Function en Department object. In de onderstaande opsomming is te zien welke gegevens van de DebtorService Dialog gebruikt.
Functie:
- Id
- Description
Department
- Code
- Description
2.3: Importeren in Dialog
Nadat de koppeling is geactiveerd voor Nmbrs, zal deze automatisch iedere nacht gebruikers ophalen. Dit kan ook handmatig gedaan worden vanuit het integratie scherm in Dialog.
Het is belangrijk om te weten dat na het importeren van de gebruikers, ze nog niet direct klaar zijn om gebruik te maken van Dialog. Op het integratie scherm zal een lijst tonen van alle geïmporteerde gebruikers. Hier zijn ze eenvoudig uit te nodigen voor Dialog of te koppelen aan een al reeds bestaande Dialog gebruiker.
Nadat een gebruiker is uitgenodigd in Dialog zullen veranderingen in Nmbrs niet meer worden doorgevoerd in Dialog. In Nmbrs verwijderde gebruikers zullen niet automatisch worden verwijderd in Dialog.
Stap 3: Terugsturen van beoordelingen (pdf)
Dialog stuurt indien mogelijk afgeronde beoordelingen terug naar Nmbrs in pdf-formaat. Dit gebeurt op het moment dat een beoordeling in Dialog als afgerond wordt gemarkeerd. De beoordelingen zullen worden opgeslagen bij de documenten van een specifieke medewerker. Er is geen verdere configuratie in Nmbrs nodig voor het terugsturen van beoordelingen.
Let op: Deze integratie werkt alleen voor reeds gekoppelde gebruikers. (Stap 2)