Premium API

This article will guide you through the process of turning on and generating your API keys and rate limits. Premium API is an Add-On Feature for Pro Tier Firms. 
This feature can be turned on in your Firm Settings, if you do not see the Billing Tab then the API has to be turned on by contacting your Account manager.

There are two sizes for the API Gateway limits. These limits apply to the entire Firm, and not to the individual User(s).

Small
Medium

Enable API Keys

Users with a Partner or Admin role can Navigate to the Firm Settings. 

Click on the "Billing" Tab and scroll down to the list of subscriptions and features.

Toggle on the Premium API and click to confirm the Add-On.

How to Create Keys

Once you have your Premium API turned on then navigate to Your Profile and a section showing “API Keys” will be present.

Click “Create” to generate your API Keys. That will provide you with the API Key itself and the Secret Key. There is a high importance that you do not share or lose these keys. Users have the ability to download (in excel format) or copy the keys to easily save them somewhere safe. 

**Please Note: Once the window is closed, the Secret Key can not be opened in Clockwork. If you do not have the Secret Key after closing this window then new keys will have to be created.**

After closing the previous window, the API will become active with the status and date created.

You can “Make Inactive” or “Delete” to pause or remove the key the API at any time. Making a Key inactive removes it from service for connected integrations. Deleting a key removes the key indefinitely. 

After deleting an API Key, users can regenerate another by clicking “Create”.

Please contact support for the developer documentation and they will be happy to further assist you!