Prerequisites
Before getting started, please carefully read the following to make sure you fulfill 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:
1. Log into your Nmbrs account.
2. Click on the “User Profile” tab. You can find it on the top right corner of the page:
3. Navigate to the "PROFILE" section of the "USER PROFILE" page, and make sure that your account has "Administrator" type. Find out who is the "Administrator" in your company's Nmbrs instance, and ask them to assign your the account the type or take over the setup process if you are not an "Administrator":
Find your API domain
Your API domain is the same domain that you use to login to Nmbrs account.
Open your Nmbrs login page, you should be able to view your domain here.
Assign Permissions
-
Click on the settings cog in the left sidebar, then "USER TEMPLATES":
-
Scroll down until you see "(Scenario 3) General Manager Payroll & HR", then click on the cog underneath "API":
-
Select the relevant service, for example, "Employee Services", from the dropdown:
You will find all relevant permissions for your integration listed in the connection flow:
Please note: These might be different for your integration.
-
Ensure all the right permissions are enabled under each service:
Generate API credentials
-
Log into your Nmbrs account.
-
Open the “User Profile” tab. You can find it on the top right corner of the page.
-
In the “User Profile” page, click on “API TOKEN” tab.
-
Click on “Activate API Account” button
-
A token should be generated and displayed.
-
Copy email and token and paste them in the connection flow page. Then click on “Set up Integration”.