Nmbrs koppelen via een API token

⚠️ Disclaimer: Vanaf 1 maart 2027 wordt de SOAP API niet meer ondersteund. De REST API is vanaf dat moment de enige API die wij aanbieden.

Mocht je vanuit de Nmbrs App Store worden doorverwezen naar deze pagina, dan is het alleen mogelijk om dit softwarepakket te koppelen met Nmbrs via een API token. Wil je zelf een koppeling bouwen met Nmbrs? Dan kan je dit uiteraard realiseren via onze API. Een koppeling die nog niet bestaat, kan op die weg gerealiseerd worden. Voor meer informatie hierover, zie dit artikel.

In dit artikel behandelen we de volgende onderwerpen:

 

  1. Wat heb ik nodig om een API token aan te vragen?
  2. Hoe vraag je een API token aan voor logins op het hoogste niveau?
  3. Hoe vraag je een API token voor een login op debiteurniveau?
  4. Het API token gebruiken

 Wat heb ik nodig om een API token aan te vragen?

Om een API-token te kunnen maken, heb je een login nodig. Er zijn verschillende logins beschikbaar, met elk hun eigen functie. Wil je koppeling voor meerdere debiteuren, dan kan je het beste een login op het hoogste niveau aanmaken. Wil je één klant specifiek koppelen voor een debiteur, dan kan je het beste een login op debiteurniveau aanmaken.

De volgende stappen geven aan hoe je een login aanmaakt op het hoogste niveau. Om de loginrechten te geve één specifieke debiteur, kan je dezelfde stappen uitvoeren maar dan op debiteurniveau. 

Let op: Gebruik bij het aanmaken van een login voor een koppeling altijd een generiek e-mailadres en een herkenbare naam (bijv. Koppeling Systeem X). Als een login later wordt verwijderd of gedeactiveerd – bijvoorbeeld omdat een medewerker uit dienst treedt – verbreekt de actieve koppeling. Met een generiek account voorkom je dit risico.

1. Ga op het hoogste niveau naar 'Instellingen' en klik op 'Logins'. 

2. Maak een nieuw account aan. Het maakt niet uit welk template je kiest.

Note: de rechten voor de dashlets, zoals ingesteld in de template users, hebben geen invloed op de rechten wat betreft API. De gebruiker kan nog steeds toegang hebben tot alle niveaus. Deze rechten zijn in te stellen bij template users door op het icoontje 'API user template' te klikken.

3. Klik op het envelopje naast de login die je zojuist hebt aangemaakt, zodat er een activatie e-mail naar het e-mailadres verstuurd wordt.

4. Afhankelijk van de ingestelde filters met betrekking tot debiteuren tags zal de gebruiker nu toegang hebben tot verschillende debiteuren. Voor meer informatie over het instellen van filters zie het artikel Debiteuren tags aanmaken.

Om de integratie tot stand te kunnen brengen dient de gebruiker in te loggen op zijn account en de API token aan te vragen. Hoe je dit doet, kun je hieronder lezen.

 

Hoe vraag je een API token aan voor logins op het hoogste niveau?

Alleen gebruikers met een template dat gebaseerd is op 'Master Accountant' (in een accountant omgeving) en gebruikers met een template gebaseerd op 'Master Client' (in een business omgeving) kunnen dit doen.

1. Klik op het icoontje rechts bovenin de hoek van het scherm.

2. Klik vervolgens op 'Gebruiker Profiel'.

3. Klik op het tabje 'API Token'.

4. Klik op 'API account activeren' om de token op te vragen.

Vervolgens zie je het beeld, zoals hieronder is weergegeven. Je gebruikersnaam is het e-mailadres dat ook gebruikt wordt om in de omgeving in te loggen en het token is eronder weergegeven.

Hoe vraag ik een API token aan voor login op debiteurniveau?

Een koppeling voor slechts één debiteur kan worden gelegd met behulp van een klant login. De API token voor een klant login kan worden geactiveerd en bekeken worden vanuit de instellingen 'Klant login' op debiteurniveau.

Zorg ervoor dat het account is geactiveerd.

Het API token gebruiken

Sla de gebruikersnaam en het token op, of kopieer deze. Je bent nu klaar om de integratie op te zetten. Ga naar https://api.nmbrs.nl/ om te zien welke calls uitgevoerd kunnen worden.

Opmerkingen