/
API Keys

API Keys

Owned by Pat Zelei
Last updated: Mar 31, 2025 by Amanda Folkman
2 min read

An API Key is a unique identifier that authenticates two applications to communicate with each other.  API is the acronym for Application Programming Interface.    Only an Admin user will see API Keys as an option under the System menu.  

Create the API Key

  1. From the Systems menu select ‘API Keys’

  2. Click image-20250314-202657.png

  3. Enter desired information into API Key fields

    1. Created By: User creating the API Key

    2. Created Date: Date API Key created

    3. Description: Enter the description of the key

    4. Expiration Date: Enter Expiration date for the API Key

    5. User: Select user from dropdown to set up the API key for the User to be assigned as the USAS Workflows System User.

      image-20250325-133856.png

 

  1. Click Save and a Pop Up box will show the API Key.  NOTE:  For security, this API Key will only be shown once so before closing the Pop UP via X, proceed to step 4. 

 

  1. Copy this API key to clipboard or download text file prior to exiting.  This API Key will not be accessible again as a security measure.  It is blacked out for documentation purposes. 

  2. This API Key will be entered in the Workflows Integration under the System menu.

Search/View API Key

The API grid allows the user to search for existing API Keys by clicking in the filter row and using filters.  The Advance Query is also an option to Search.  To view, click on . 

Edit API key

Click on in the grid to Edit the Description of the API Key.  You will not see the API Key when editing.

Delete API key

Click on in the grid to Delete the desired API Key.  A confirmation box will appear asking to confirm that the API Key should be deleted.   

 

 

 

 

 

Related content