How to create and revoke an API key
API keys let your own systems - an ERP, a script or another app - use the OrderKrab REST API. Owners and admins create them; each key belongs to one organization.
- 1
Go to Settings → API & Apps.
- 2
Under API keys, click Create API key.
- 3
Enter a Name that says which system uses it, for example ERP sync. Tick Allow changes (write access) only if the system has to update orders, create labels or handle returns. Click Create.
- 4
Copy the key in the next window and store it in your system's secret settings, then click Done. The key is shown only once.
- 5
To stop a key, click Revoke next to it and confirm. Systems using it stop working right away.
Good to know
- A key acts on behalf of the person who created it. It stops working if that person leaves the organization or is no longer an owner or admin.
- Each key can make 300 requests per minute.
- Developers find endpoints, examples and error codes in the API reference.