API
Getting your first API key.
Make your first request.
Prerequisites
Only store owners can get an API key. If you're not a provider and you do not have your store-owner account yet, please contact your provider. If you're a provider and you do not know how to create a store-owner account, please follow the instructions available here
Will other account types get access to API keys in the future?
Our API service mainly offers automation solutions for creating, deleting and modifying jobs, clients and more. These services are all expected to only be needed by store owners.
Steps
- Once logged in as a store owner, navigate to the 'API Management' page.
- Click on 'Get your first API key' to navigate off of the landing view.
- Choose your permissions and preferences and create.
For more information about these options, see key options. - Save your key's secret key somewhere safe.
The secret key can only be viewed once. If lost, you will have to delete your API Key and create another.This is to minimize the risks of your API key getting stolen, and thus others having access to your data. In fact, after this initial setup, the key is never again exposed or sent through any request. - Congratulations, you have your key!
Some code snippets are available on the app for you to explore. More detailed guides are available here in the documentation.
The API Key's ID is NOT the secret key and cannot be used in requests — this ID serves only as a unique identifier for your key.