API Keys 

Introduction to API Keys

An API Key lets you securely connect to the GS API.

GS will generate a secure API Key that includes:

•  a static API Key ID
• an API Key Secret that you can Reset

Your application must provide this secure API Key to the GS API with the header GS-Api-Key .

Creating, editing, or viewing API Keys

To create, edit, or view an API Key:

1. On the navigation menu , expand the Access section. Then select API Keys.
   1. 
   2. This displays a list of the GS API Keys:
   3. 
2. To create an API Key, select the Add button.
   1. To edit an API Key, select the Edit button for that API Key.
   2. To view an API Key, select the View button for that API Key.
   3. 
3. Set or change the Required settings (below) for that API Key.
4. Set or change the Optional settings (below) for that API Key.
5. 1. Select the Save button at the top or bottom of the page to save your changes.
   2. 
6. If creating a new API Key, this generates a secure API Key comprised of a static API Key ID, a period, and an API Key Secret that you can Reset.
   1. Your application must provide this secure API Key to the GS API with the header GS-Api-Key .
   2. 
   3. After saving the new API Key, the static API Key ID is displayed when you view or edit the API Key and when you view the list of API Keys.

Required settings

Name

• Each API Key must have a unique Name.

Role

• Choose the Role for this API Key.
• The most secure way to set up API connectivity is to select a Role with the minimum Permissions needed for your application to perform the desired Operations on GS. 

Locations

• Locations are managed in the Admin menu.
• Assign this API Key to one or more Locations.
• * If the Role (above) is Admin, this API Key can access all Locations.
• * Not shown if you only have one Location.
• * Not shown in GS Essential.

Optional settings

Language

• Currently supported languages are English and Spanish.
  • If you need another language, contact us.
• When this setting is blank, GS checks the browser language.
  • If it matches one of the supported languages, GS will automatically use that language.
  • Otherwise, GS will display in English.

API Key Reset

Users set to the Admin Role can reset API Keys.

After resetting an API Key, you must update any integrations that reference that API Key.

1. On the list of API Keys, select the View button for the API Key you want to reset.
   1. 
2. Select the button and then select Reset Password. Then select the Reset button.
   1. 
   2. GS will display a new secure API Key comprised of the original API Key ID, a period, and a new API Key Secret.
   3. 
   4.  Remember to update any integrations that reference this secure API Key.

Disabling an API Key

When an API Key is no longer active, you can Edit or View that API Key to Disable it.

This will:

• prevent it from connecting to the GS API
• hide it from all lists of API Keys

If you have disabled API Keys, you can always view them again by selecting the Show Disabled checkbox.

When an API Key is Disabled, you can also Edit or View that API Key to Enable it.

Deleting an API Key

When an API Key becomes inactive, you will typically disable that API Key.

However, if the API Key has never been used to enter data or create entities, you can delete that API Key.

1. On the list of API Keys, select the View button for that API Key.
   1. 
2. Select the  button and then select the Delete button.
   1.