For developer API documentation please visit our documentation page.
Turning API Access on for your Org
Note: API Access is always available for admins, but must be enabled for non-admins.
API access is turned off by default, to enable API for your organization as an admin, visit the User Roles tab. Under the Misc section, click on the API Access switch to be set to Allowed. This allows non-admins to request and use API keys.
Getting an API Key
Once API Access is enabled for your organization, an API key can be requested from the Your Settings & Preferences tab in your Settings. In the API Key section, when you toggle the switch on, an API key is automatically generated. To get a new key, click Regenerate New Key, please note that generating a new key will cause any references using your old key to be void.
To start, select your navigation menu and select "Your Profile & Preferences"
Next, navigate to your API Access section.
Managing API Access
Admins can keep track of users who have active API keys from the API Management tab in Security. This tab shows all users who have an active API key and any Zapier triggers registered to them. From here, admins can turn off an API key for any user by clicking Clear API Key. If the user has any Zapier triggers registered to their key, it will show up in the User's Webhooks section with details pertaining the trigger. To pause or play the trigger, select and highlight a trigger before pressing configure.
Where Is My API Key?
Your API Key can be found in your Settings Tab under "My Settings & Preferences". You will have to enable your API Key. Once Your API is enabled, you will be presented with your API Key.
If you ever need to regenerate a new API Key, you can do so by clicking "Regenerate New Key". However, please note: Any Change in API KEY (for instance generating a new key or turning API Access off) will result in any exsisting links with the old API key to fail.
Managing API
If you would like to manage your API, you can do so by going into your settings and clicking API Management under (Advanced Settings). You will presented with a screen that will allow you to manage users who have turned on API Access. If you click on a user who has enabled their API, administrators will have the option of turning off API Access for that user. Administrators can do this by clicking "Clear API Key". Clearing the API key will cause any references to that API Key to fail and will turn off that users API access to that specific API key. If that user would like API access again, they will have to regenerate another API key.
To start, select your navigation menu and select "Your Profile & Preferences"
Next, navigate to API Access
Clicking on a user also allows you to view the webhooks that are subscribed to that user.
A users Webhook displays any "webhook subscribed to the user.
URL: where Crelate is sending information to.
Entity: Entity for which the webhook is triggered on
Operation Type: the type of operation for which the webhook is triggered on
Status: the status of the webhook. - Webhooks that are off do not send any information out on trigger.
Where Is The API Documentation?
There are two ways to view your API Documentation - both ways are in your settings.
You may also access our help section here: Crelate API Developer Guide for our full guide.