Creating an API user

An API user is an employee created in Nimbus that has an API User flag. The purpose of the API User is to provide third party integrations with authorized access to your Nimbus account via the Nimbus API.

When the API User checkbox is ticked on the Nimbus Employee profile:

• a subscription fee is not charged for this user; and

• if the credentials are used to login to the Nimbus application in the browser there will not be any menus available.

To create an API user:

1. Login to your Nimbus account as an admin user

2. Select Admin from the menu panel

3. Select Manage Employees

4. Click the New Employee icon in the top right toolbar

   Open

   

5. Enter a Login Code, Salutation, First Name, Surname and Email:

   Open

   

   1. The login code and names can be any values, ideally something that will help you recognise this is an API User and the application it is used for.

   2. The email address must be valid to receive the Welcome email which will allow you to setup a password.

6. On the Access tab, tick API User:

   1. Once ticked, the other menu items will be deselected and greyed out.

7. 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'.

8. Click Update. The API User will be added to the Employees grid. A Welcome email will be sent to the nominated email address or click the Send Welcome Email icon

9. Click the Account Login link in the Welcome email. The First Password screen will be opened in the browser

   Note: If your Nimbus is account is using an SSO to log in (Microsoft, Practice Protect or Xero) then this Account Login screen is redirected to the SSO login. To override this redirect:

   1. right click on the Account Login link in the email and copy the link

   2. paste the URL into the browser

   3. add &ssooverride=yes at the end of the URL before it is invoked

   4. Click Enter

   5. The First Password screen should be displayed.

10. Enter a Password and if required, a 2FA Pin. Click Login.

    1. Note: The Passkey Login Type should not be used for an API User.

11. The Nimbus account home page will be displayed. You now have your API User credentials ready to use with the third party integration.