Create a new API key

STOP: Is the API module enabled for your organization?

 

The "Admin" area is only accessible by administrators; only API Administrators can perform the functions detailed on this support page. 

 

How do I create a new API key?

Navigate to the "API Keys" admin page, then:

  • Click  in the top right corner of the page.

 

In the resulting window: 

  • Enter a name for this key in the "Name" field.

  • Determine what items a key has permission to access:

    • Assign it to at least one Location. To do so, click  in the top right corner of the "Network Locations" section and check the boxes next to each Location you want to add.

    • Grant it any necessary Roles. To do so, click  in the top right corner of the "Roles" section and check the boxes next to each Role you want to add.

  • Click .

For more general information about using API keys, check out this page.