Skip to content

Developer keys

Developer keys is at /settings/developer and needs the settings.manage permission, because a key can reach the store’s data. The screen’s description is: “Keys let your own scripts and tools call the CIQRA API with exactly the access you choose. A key is shown once, can only ever be narrowed, and stops working the moment you revoke it.”

The feature is enabled store by store. A store without it sees “Developer keys aren’t switched on for this store.” and “Ask CIQRA support to turn them on.”

Create key opens a form with:

  • Name — “Something you will recognize later, like “nightly stock sync”.”
  • Access — the scopes. “Choose only what this key needs. It can be narrowed later but never widened.”
  • Valid for (days) — a whole number of days; the form states the maximum.
  • Requests per minute — a rate limit, up to a maximum the form states.
  • Allowed addresses (optional) — one IP address or network per line, for example 203.0.113.7 or 10.0.0.0/16; empty allows any address. The form accepts at most 20 addresses (limit as the screen states it, read 2026-11-11). Where the platform does not apply address limits, the screen says the list is saved with the key but not applied.

After creating it, the screen shows the key once: “Copy this key now. For your security it is shown only once and cannot be recovered. If you lose it, revoke it and create a new one.” It also states the date the key stops working.

Each key shows a status (Active, Expired, Revoked or Switched off), when it was created and last used (or “never used”), the expiry date with the days left, its request rate and any address restriction.

Narrow lets you only take access away: “You can only take access away. To give a key more, create a new key.” You can keep fewer scopes (at least one), lower the request rate, add addresses to an unrestricted key or remove addresses from a list (“an address list can’t be emptied”) and Switch this key off, which “stops working and can’t be switched back on.”

Revoke asks “Revoke this key?” and states that the key “stops working immediately. This can’t be undone.”