Chapter 1 of 5
Chapter 1 of 5
API keys
An API key lets another application, such as your tracking sheet, Zapier, Make or your own software, read your store's data. It is like a password for machines. Keep it the way you keep yours.
Create a key
- 1. Click Integrations in the side menu and click New key.
- 2. Type a Name that reminds you where you use it.
- 3. Tick the Permissions it needs.
- 4. Click Create key.
- 5. Copy the key with Copy, save it and click I've saved it.
The full key is only shown when created. Afterwards the list only says its name, its permissions, who created it and its last use. Only the owner and administration can create them.
The permissions
With Read sales, refunds, subscriptions, contacts and invoices can be looked up. With Write contacts can also be saved with their tags and webhooks managed. Give only the permissions the application needs. A tracking sheet only needs to read.
One key per tool
Create a different key for each tool, with a name that identifies it, such as Store Zapier or Accountant sheet. That way, if a tool stops being used or its key leaks, you revoke it without touching the others.
Rotate a key
Rotate a key when you want to change it without cutting your tools. Open the key's menu and click Rotate. The previous one appears as Replaced and keeps working for 24 hours while you put in the new one in your tools.
Revoke a key
If a key leaks, click Revoke. It stops working at once. The Zapier and Make webhooks created with it are deleted too. API keys explains it.
The quota
The request quota is per store and adds up all your keys, Zapier and Make included. If you go over it, the API answers that you should wait and your tools retry.
What you have now
You have one key per tool. In the next chapter you receive notices with webhooks.
Was this helpful?
Need to talk to us?
If you didn't find what you were looking for, write to us. We reply within two working days.