Using API Keys

Integrate with third-party apps and services through our API. Forecast makes it easy to integrate with other third-party apps and services. The Forecast API is a complete programmable interface to all Forecast functionality. This is a REST-style API that uses JSON for serialization and HTTP. For more information on Forecast's API, check out For Developers.

This article covers:

• Generating a new API key
• Managing API keys

Generating a new API key

API keys are used to access Forecast's API and in some integrations.  Admins can create new API keys from Admin. 

To generate a new API key

1. Click Admin in the top bar. 
2. Select API Keys from the dropdown.
3. Click Generate New API Key.
4. The new key will appear at the end of the list. 
5. Click into the Name field.
6. Enter the name of the API key or other reference to identify the key.
   
7. The API key list includes the API key name, the key, the user who created it, the date it was created and whether or not the key is currently active. 

Managing API Keys

Admins can deactivate or delete API keys that are no longer needed or in use. Deactivated API keys may be re-activated in the future. Deleting an API key is final, the action cannot be undone. If you have deleted an API key by mistake, you will need to generate a new one.

To deactivate an API key

1. Click Admin in the top bar. 
2. Select API Keys from the dropdown.
3. Locate the API key you wish to deactivate. 
4. Untick the box in the Active column.
5. The key is now longer active.
    

To delete an API key

1. Click Admin in the top bar. 
2. Select API Keys from the dropdown. 
3. Locate the API key you wish to delete. 
4. Hover over the right side to display Delete. 
5. Click Delete.