​
First Steps

In order to use our API, you will need an API Key from our Control Panel.

You give it a name, and we’ll generate a Secret Key for you.

Keep in mind that API access is only available with one of our paid plans.

All endpoints are described at the sidebar. You should learn how to Authenticate next.

​
Recommendations

We encourage you use one different API Key for any subsystem you have that might need to interact with Cavok.

That way, any unforeseen usage can be revoked and limited to that subsystem.

Beware that an API Key have access to most Control Panel features regarding to Resources.
They must be treated as a Secret.
API requests are limited by throttling, to avoid excessive usage from one set of keys.

Was this page helpful?