Addigy provides all of its partners with a robust REST API for integrating one's systems and solutions. To add an API integration, you will need to be logged into an account with both the Create Integrations privilege and the View Integrations API privilege. For more information on user privileges within Addigy, check out our article, Managing User Privileges Within Addigy.
Note: In addition to the client key and secret, you may also be asked for a domain. This will be the Addigy realm you created the key in, such as prod.addigy.com
Creating API Credentials
To leverage the Addigy API, you will need to create a key and secret within Addigy.
- Navigate to the Account > Integrations page from the left column menu.
- Click the V1 button and select New API Token.
- Note: For the duration of the instance, the API key or user is generated as an Addigy user. Although a user's permissions may be restricted, they cannot be limited to a single policy or its sub-policies. Furthermore, this idea is only possible with API V2. If the integration requires API V1, this version does not include the concept of users. An API V1 key you create has access to all resources; it does not have user or permission capabilities.
- Note: For the duration of the instance, the API key or user is generated as an Addigy user. Although a user's permissions may be restricted, they cannot be limited to a single policy or its sub-policies. Furthermore, this idea is only possible with API V2. If the integration requires API V1, this version does not include the concept of users. An API V1 key you create has access to all resources; it does not have user or permission capabilities.
-
A window will appear asking you to name the integration.
- Give the new API integration a name and click Save.
-
A window with the client ID and client secret will appear.
Note: As stated in the window below, the Client Secret Key token will not show up again once the configuration is complete for security purposes. Make sure to keep it safely secured. Additionally, the client ID will not fully display as well.
- The newly created API integration will be shown on the Account >> Integrations page.