Prerequisites
Before getting started, please carefully read the following to make sure you fulfil all requirements for the integration to work.
You are an admin of your Nmbrs instance or an admin shared their access with you. This is necessary for retrieving the API credentials as explained later in this guide.
You can check this by following the steps below:
- Log into your Nmbrs account and click on the “User Profile” tab. You can find it on the top right corner of the page.
- Navigate to the "PROFILE" section of the "USER PROFILE" page, and make sure that your account has the "Administrator" type.
🚨 If you are not an administrator, find out who is the Administrator in your company's Nmbrs instance and ask them to assign your account the "Administrator" type or to take over the setup process.
In general, this guide is written for Nmbrs Business tenants. Generally unless you are part of an accountancy firm you will have a Business tenant.
- If you have an Nmbrs Accountant tenant, the guide should still work, however, if you only want give access to the data of a particular client, you may need to log in into the Business sub-tenant of your client with an admin account.
Step by Step Integration Setup Instructions
Step 1 - Find your API Domain
The first step in Ravio is to enter your Nmbrs domain. This is the start of the web address you access Nmbrs through. If you, for example, use Nmbrs on example.nmbrs.nl, then your subdomain is example.
Step 2 - Establish which permissions you need for Ravio
Once you have entered your subdomain and hit Continue, you will be presented with a page that contains the list of Scopes / Permissions that you have to assign in Nmbrs before completing the integration.
🚨 Note: These will be different for your integration. You will see the correct permissions for your integration once you go through the connection flow in Ravio.
Step 3 - Assign Permissions
Click on the settings cog in the left sidebar, then "TEMPLATE USERS" (it may also be called "USER TEMPLATES"):
Scroll down until you see the User type of your user that you noted down earlier (it should be in the 'Master Client' section). In this example, the User type was "Administrator Gebruiker", so we are looking for this name. After you have found it, click on the respective cog in the "API" column:
Select the relevant service, for example, "Employee Services", from the dropdown. Once selected you will find all relevant permissions for your integration listed in the connection flow. We need to ensure all the right permissions are enabled under each service.
Step 4 - Generate API Credentials
In your Nmbrs account open the “User Profile” tab. You can find it in the top right corner of the page. and in the “User Profile” page, click on the “API TOKEN” tab.
Click on the “Activate API Account” button and a token should be generated and displayed. Please copy this information now as once you leave this screen you will not be able to see your API token again.
Step 5 - Enter these details in Ravio
Paste the API Token and Email into the connection flow page. Then click on “Set up Integration”.