Skip to main content

Management

Manual Authentication​

To perform most API key related operations, it is advisable to use our OpenAPI Specification Explorer and authenticate using the OAuth 2.0 flow.

Create​

Creating an API key can be done by:

  1. In the OpenAPI Specification Explorer open the section labelled Generate New Api Key, press Try it out and then Execute.
  2. Copy the API Key which can found in the returned JSON body.
{
    "id: "abcdefghijklmnop",
    "active": true,
    "expires": "2024-09-16T10:55:34+00:00",
    "key": "YOUR_PERSONAL_ACCESS_TOKEN"
}
note

You can only have one API Key active at any time, if you'd like to generate a new key, you'll need to Revoke the old one first.

tip

The API Key is valid for 12 months from the time of generation for security reasons but can be easily extended for an additional 12 months by following the steps in Extend.

Get​

You can retrieve your existing API Key by simply:

  1. In the OpenAPI Specification Explorer open the section labelled Get Api Key Info, press Try it out and then Execute.
  2. Copy the new API Key found in the returned JSON body.
{
    "id": "abcdefghijklmnop",
    "active": true,
    "expires": "2024-09-16T10:55:34+00:00",
    "key": "YOUR_PERSONAL_ACCESS_TOKEN"
}

Revoke​

If you need to revoke an API key at any time and for any reason:

  1. Follow the steps to Get an existing API Key and copy its id.
  2. In the OpenAPI Specification Explorer open the section labelled Revoke an Api Key, press Try it out
  3. Paste the API Key id in the key_id parameter field.
  4. Press Execute.

The API Key will be revoked and will be unusable across all of ClearMacro's systems with immediate effect.

Activate​

If you need to reactivate a previously revoked API Key:

  1. Follow the steps to Get an existing API Key and copy its id.
  2. In the OpenAPI Specification Explorer open the section labelled Activate an Api Key, press Try it out
  3. Paste the API Key id in the key_id parameter field.
  4. Press Execute.

The API Key will be activated and can be used again across all of ClearMacro's systems with immediate effect.

Extend​

If there is less than 30 days before your API key expires and you wish to extend it for another year:

  1. Follow the steps to Get an existing API Key and copy its id.
  2. In the OpenAPI Specification Explorer open the section labelled Extend an Api Key, press Try it out
  3. Paste the API Key id in the key_id parameter field.
  4. Press Execute.

The API Key will be extended for another year from the time of the extension request.