Create an integration

The first thing you will need to use the Clarify APIs is an integration. To create one, follow the steps shown in the video below.

Credentials

Once you have created an integration, it's time to create a set of credentials that we can use to authenticate calls to the API. Clarify supports two kinds of credentials, either OAuth 2.0 client credentials or Basic auth.

For our Python SDK and Node-RED node you will need to select OAuth 2.0, while if you are writing your own code to use with the APIs it might be easier to use the Basic auth method as you can use the key directly in calls to the API instead of generating access-tokens.

tip

Don't worry if you create the wrong kind of credentials, you can create multiple credentials of any type for a single integration. It's also possible to delete credentials if you decide to switch type.

OAuth 2.0

Once the window is closed the credentials cannot be downloaded again, so make sure you store it. Make sure to store the credentials in a safe place, as this file can be used to interact with data in your organization.

Basic Auth

Once you've pressed create, a username and password will be shown. For security reasons, once the window has been closed they can no longer be retrieved. Take care to ensure that these are stored somewhere safe as they can be used to interact with data in your organization.

For more details, see the reference guide.