An API user is an employee created in Nimbus that has a API User flag. When this flag is ticked on the profile:
A subscription fee is not charged for this user
if the credentials are used to login to the Nimbus application in the browser there will not be any menus available.
The purpose of the API User is to provide third party integrations with authorized access to your Nimbus account via the Nimbus API.
To create an API user:
Login to your Nimbus account as an admin user
Select Admin from the menu panel
Select Manage Employees
Click the New Employee icon in the top right toolbar
Enter a Login Code, Salutation, First Name, Surname and Email:
The login code and names can be any values that will help you recognise this is an API user.
The email address must be valid to receive the Welcome email which will allow you to setup a password.
On the Access tab, tick API User:
Once ticked, the other menu items will be deselected and greyed out.
In the Doc. Mgt. tab you may add workflow status' that you want to be available when profiling the document in the third party integration. Alternatively, you can add the API User to any Teams that you have setup with workflow status'.
Click Update. The API User will be added to the Employees grid. A Welcome email will be sent to the nominated email address
Click the Account Login link in the Welcome email. The First Password screen will be opened in the browser
Enter a Password or Passkey and if required, a 2FA Pin. Click Login.
The Nimbus account home page will be displayed. You now have your API User credentials ready to use with the third party integration.