API Access Prerequisites

Gathr SaaS users can use the REST APIs to perform various actions in their Gathr accounts.

To access Gathr and perform tasks using REST APIs, you will need to provide your Gathr account’s API key as a header in the respective API service.

Generate Access Key #

The steps to generate a Gathr account’s API key are described below:

1. Login to your Gathr account and navigate to the User Profile section.

2. On the Access Keys tab, click on GENERATE KEY.

   

   An API access key will be generated.

3. Copy the API access key and store it securely.

   

4. Click on CONTINUE to mask the generated API key permanently. This is done to prevent any misuse of the API key.

   Once the key is masked, it cannot be reaccessed. But, there is always an option available to Regenerate the Access Key.

Delete Access Key #

The steps to delete a Gathr account’s API key are described below:

1. On the Access Keys tab, click on Delete Key.

   

   A confirmation will be required to delete the access key.

   Caution: Deleting API key disables Gathr Rest API authentication.

Regenerate Access Key #

The steps to regenerate a Gathr account’s API key are described below:

1. On the Access Keys tab, click on REGENERATE KEY.

   

   A new API access key will be generated.

2. Copy the API access key and store it securely.

   

3. Click on CONTINUE to mask the generated API key permanently. This is done to prevent any misuse of the API key.

Test Gathr API #

Test Gathr API through a REST API Service Tool

To test the Gathr API REST calls via a REST API service tool or to utilize them in a program, it will be required to pass the Access Key as a header for authorization.

The user token for account authorization can be provided in any of the API service tools as follows:

1. In your preferred API service tool, navigate to the setting where you can add Headers.

2. Add the authorization header to allow the API service to access Gathr as follows: