API

How Do I Create an API Key?

An API (or Application Program Interface) is a set of protocols, rules, tools, or definitions for building application software.

The API Key is a name given for a unique token that is submitted alongside a web service to identify the origin of the request. If the request is successfully identified, then it acts as an authentication and provides a set of access rights.

To access the integrations we offer that utilize an API token or key:

  • Click on your profile icon or initials in the top right corner
  • Select Settings from the drop-down menu
  • From the Settings menu on the left, open the API tab

On this page, you can create an API Key by clicking on the blue New API Key button in the top right corner.


Integrations - API


This will pull up a number of fields.


Integrations - API Key


Here, you can:

  1. Select a third-party software from the drop-down menu under the Description column.
    1. The available options include:
    2. If there is not an option that is included on our integrations web page, you can manually type the name into the drop-down menu field and it will be added to your account.
    • Assign an Access Profile to the API key
    • Save the API integration

    A string of characters will then populate under the Key column. You can copy the token and use it to complete the integration with a third-party software.