All Collections
Accessing the API with a Token
Accessing the API with a Token
Access our API endpoints using an API token
Updated over a week ago

Our API is continuously in development. You will be notified of upcoming changes ahead of time so keep a look out for any updates.

Generating your API access key

We use JWT specifications to generate your access keys. You can read more about it on :โ€‹

To generate a new API key

  1. Log into your Kickflip dashboard.

  2. In the left side bar, under "Account Settings", click on "API keys".

  3. Click on "+ ADD KEY"

You can choose the desired permissions fitting your needs. Keep in mind that this cannot be changed afterwards. You can however generate as much API keys as you want.

Please note that once you've created an API token, you cannot delete it nor modify

its scopes. Be VERY careful not to leak it, so please take the necessary security measures.

E.g. Keep it in a separate configuration instead of hardcoding it in your codebase.

Description of API key scopes



Full read and write access

Every endpoint to our API is accessible and you can update the data.

Full read access

Every GET endpoint to our API is accessible. You cannot update the data.

Access content of orders

These endpoints only are accessible : GET /orders and GET /orders/:orderId

Access content of designs

These endpoints only are accessible : GET /designs and GET /designs/:designId

You can then copy your API Key. Like passwords, API keys should remain a secret.

Use this API Key as the bearer token (Authorization header) on every request you make to our endpoint. Here's an example of a call made to GET /designs endpoint using a fake API key with Postman :

Did this answer your question?