# Nimbus API

TIP

The Nimbus API is only acessible from the Nimbus workstation or server. To expose the API outside of the current device, a reverse proxy such as IIS or NGINX is required.

# Authentication

The Nimbus API uses basic authentication through the X-API-KEY header. An API user is a user account in the Nimbus system that is marked as a "API User". API users can only interact with Nimbus via the API and cannot login to the front end.

# Creating an API User

Log in to the Nimbus interface
Click the cog in the top right hand corner
Click User Manager
Click Add User
Enter the following details:
- Username: A unique username for the account
- Last Name (optional): A description of what the API user is for
- Password: A secure password, although it is reccomended to avoid the colon ( : ) character for API users
- Confirm Password: Same password as above
- User Type: Select "API User"

api_user_setup

Click Save Changes

# Using Credentials

WARNING

NEVER use the sample usernames or passwords below in your system. Always use unique, secure usernames and passwords.

Concatenate the username and password together, seperated with a colon. For example;

apiuser:apipassword1

Base64 encode the above with a tool such as base64encode.org, which should result in a string of text similar to the below.

YXBpdXNlcjphcGlwYXNzd29yZDE=

Pass the Base64 encoded string in the X-API-USER header with the below requests.

# API Methods

TIP

The base url for the Nimbus API is https://localhost:5042/. This will change if you use a reverse proxy.

# Address Book

# /api/v1/addressbook [GET]

Returns entries in your local address book

This method takes no paramaters.

# /api/v1/addressbook/search [GET]

Searches your local address book or the global address book

Paramater	Required	Details
searchTerm	Yes	Pass a string containing the search criteria
globalSearch	No	Pass 'true' to search the global address book, or omit to search the local address book

# /api/v1/addressbook/add [POST]

Add an entry to your local address book from the global address book

Paramater	Required	Details
profileIdentifier	Yes	Pass a profile identifier retrieved from the global address book using the /search method above

# /api/v1/addressbook/delete [DELETE]

Delete an entry from your local address book

Paramater	Required	Details
profileIdentifier	Yes	Pass a profile identifier retrieved from the local address book using the /addressbook method above