Skip to main content
All CollectionsDevelopersGetting started
How to obtain an open API key in Indigo
How to obtain an open API key in Indigo

Follow this process to receive and start using API keys for your own software needs.

Marie Claire Saliba avatar
Written by Marie Claire Saliba
Updated over a year ago

To obtain an API key, you first need to create a user account in Indigo. Please note that the Indigo user account is different than your developer portal account. The Indigo user account is what will allow you to obtain API keys.

Then, to ensure that the new user can create and delete API keys, you need to create a permission set that gives the user the right to use API keys.

We recommend creating a specific Indigo account that is used by one or more API calls rather than using an existing Indigo user account. 

Multiple accounts, each with their own security rights, and an API Key can also be set up to provide different access to different APIs, thus further increasing the security.

To create an Indigo user account:

  1. Go to Administration > Main > Users.

  2. Click the Insert + button in the functions bar.

  3. Create the API user account and provide your company name with it to set it apart from other API user accounts. Consider giving the API user a generic name, such as “API_User@[yourcompanyname]”, to make it distinguishable from normal users.

  4. Set Access Rights that you want the API to utilise.

  5. Click the Save button to save the user.

This account needs one important permission set assigned to them to ensure they can use an open API key.

To create a permission set for using API keys:

  1. Go to Administration > Main > Permission Sets. 

  2. Click on + Insert in the functions bar. 

  3. Enter a code and description of the new permission set (see the screenshot below for an example). 

  4. Click Save (check mark icon).

Next, to add the use of API permission to the new permission set:

  1. Click on the new permission set. 

  2. Click on the Unassigned Permissions tab. 

  3. Select the box next to Foundation_CreateApiKeyCommand. 

  4. Click on Insert (plus icon) in the functions bar.  

  5. In the pop-up window, be sure that Execute is selected. 

  6. Click Save.

It may be necessary to refresh the web page so that the new permission set is visible in the Users page.

The last step is to assign this permission to the new user:

  1. In the left sidebar of Indigo, click on Administration.

  2. Click on Users in the Main section.

  3. Double-click on the user who will use API keys. 

  4. Click on Edit (pen icon) in the functions bar. 

  5. Under User Permission Sets, select the new permission set containing the use of APIs permission. 
    ​

  6. Click Save (check mark icon).

How to obtain and Open API key

To create an open API key to be used by a system other than Indigo:

  1. Log in as the newly created API user in Indigo.

  2. Click on the User Profile menu and select View Profile.
    ​

  3. In the User Profile screen, click on the Create API Key option in the API Keys section of the API user’s profile.

  4. In the Description field of the resulting pop-up, enter a short name to help you identify the API key, for example, Third party integration with HR system.

  5. If the following pop-up appears, contact Shireburn Software for authorisation.
    ​

  6. The API Key will be generated. Copy this API Key to your clipboard and utilise it whenever you make an API call as a parameter to the call, as described in our API documentation.

Did this answer your question?