This article describes the steps required to manage API keys in Buttonwood Central.

API keys allow services to programmatically communicate with Buttonwood Central on behalf of the organisation.

Prerequisites

• Administrative access to Buttonwood Central

Adding API Keys

This section describes the steps required to add new API keys to the organisation in Buttonwood Central.

Procedure Steps

1. Login to Buttonwood Central
2. Navigate to Manage > API Keys
   
3. Click Add
   
   
4. On the Create API Key screen, provide the following information:
   • Name: A unique name for the key
   • Duration: The duration that the key is valid - being 1 year, 2 years, or never expires
     
5. Click Create
6. On the New API Key Created screen, note the generated Access Key
   Note: For security reasons, the key is only displayed once, only at this point, and will not be available for retrieval at a later date - lost/forgotten API keys should be disabled and a new one created
   
7. Click Close

Deleting API Keys

This section describes the steps required to remove API keys from the organisation in Buttonwood Central.

Procedure Steps

1. Login to Buttonwood Central
2. Navigate to Manage > API Keys
   
3. Select the API key(s) to be deleted
   
4. Click Delete Selected
5. On the Delete API Key screen, click Delete
   
6. A notification indicates the status of the request