API Secure Keys: Edit

To manage existing API secure keys: 

• Head to Company Settings > External Access & FTP > API Secure Keys.

Against each API secure key, you can: 

• Edit Secure Key Settings
• Regenerate The Secure Key
• Enable/Disable Access To Data Via The Secure Key
• Grant/Revoke Access To API Endpoints Using The Secure Key

If any other credentials against the secure key need changing, Contact Centegra. 

Edit Secure Key Settings

Against a secure key, select [EDIT] to adjust the following settings: 

• Transaction Source: For API keys used for transaction posting, select which transaction source transactions should record against. 

Select [SAVE] to save changes. 

Regenerate The Secure Key

If an API secure key needs to change due to security reasons, locate the API secure key within the API Secure Keys section and:  

• Select [REGERATE SECURE KEY] at the end of the row. 
• Confirm the action. 

Once confirmed, a new key is generated and access via the previous key will no longer work. 

Note that it is not possible to regenerate secure keys marked as "Centegra Admin Key". If you believe that the secure key needs to be regenerated, Contact Centegra. 

Enable/Disable Access To Data Via The Secure Key

To enable an API secure key to grant access: 

• Locate the secure key in the list. 
• Select [ENABLE]. 

To disable an API secure key to prevent any access: 

• Locate the secure key in the list. 
• Select [DISABLE]. 

Grant/Revoke Access To API Endpoints Using The Secure Key

To update access to API data endpoints via the API secure key: 

• Locate the secure key in the list. 
• Select [VIEW ACCESS].

Against the relevant API data endpoints, select either: 

• [GRANT] to provide access to the end point using the API secure key. 

• [REVOKE] to prevent access to the end point using the API secure key. 

For more information on the endpoints available, Contact Centegra.