Skip to content

Create an API key and choose its permissions

How to create a key for your website or management software, what each permission allows and how to revoke it.

Before you start

  • The public API is an add-on service: switch it on in the store plan and services.
  • You need the permission «Create and revoke API keys». The owner always has it.

Create the key

  1. Go to Settings › Products and data › API and developers.
  2. Press New key and give it a name that says what it is for (for example, «Shop website»).
  3. Tick only the permissions the integration needs.
  4. If the integration always calls from the same machines, write their IPs or networks (for example 203.0.113.0/24). Empty = from any IP.
  5. If it is for a test, set an expiry date.
  6. Press Create key and then Copy. The full key is shown only this once: keep it somewhere safe.

What each permission allows

  • products:read: products, variants and prices.
  • stock:read: sellable stock and units per warehouse.
  • customers:read and customers:write: see customers; create and change them.
  • orders:read and orders:write: see orders with their documents; create orders, which stay parked until you confirm them.
  • documents:read: invoices, tickets, corrective invoices and albaranes with their PDF.

A key can never do more than the person who created it: if you take a permission away from that person, the key loses it too.

Revoke

Press Revoke next to the key. It stops working right away and cannot be reactivated: create another one if you need it. Creating and revoking keys is recorded in the audit log and in Sensitive operations. You can have up to 10 active keys per store.

Back to the help centre