This article will show you the process of connecting as an external client to securely access and interact with our API. This is valuable for organizations looking to automate data exchange, enhance system interoperability, and streamline their operational workflows.
- Open Settings
- Click on Integrations
The short video below shows how to navigate to the Integrations screen
External Client
To acquire your unique credentials, begin by enabling the External Client. The client ID and client secret will be used later for authorization. Once copied, navigate to the Comparative Agility API documentation by clicking on it, which will open a new tab. Lastly, scroll to Auth, paste your keys in the corresponding Value fields, and click on Execute to complete the process.
By referring to our external API documentation, you can effectively evaluate our endpoints using the client ID and client secret available in the Integrations screen under Settings. This resource will guide you on the necessary request headers, requirements for each API endpoint, and the corresponding responses from each endpoint.
Comparative Agility offers 6 API resources:
- Capabilities
- Instances
- Personal Users Data
- Roles
- Teams
- Users
In the video below we show you how to authorize your API Key
Note: Access to the Integrations screen is available only to account owners.
If you ever need any assistance or have any questions please reach out to our support team at support@comparativeagility.com and we will be more than happy to assist you.