Skip to content

API keys

For Owner, ManagerAll plans

Hand your accountant a read-only key for products or receipts without giving them the Owner password.

  1. Open API keys

    Go to Settings → API keys (/settings/api-keys). This is the staff app, not Admin and not the public shop.

    API keys page with Create key and no keys yet
    API keys page with Create key and no keys yet
  2. Create with tight scopes

    Name the key (“Monthly CSV bot”). Tick only the permissions the machine needs. Forbidden on keys: manage API keys, billing, manage roles, invite/manage members.

    Show screenshot
    Create key: a name and only the access it needs
    Create key: a name and only the access it needs
  3. Copy the secret once

    Copy the akoole_… secret into your vault. Akoole stores only a hash. If you close the dialog, you must revoke and create again.

    Show screenshot
    The secret is shown once: copy it before closing
    The secret is shown once: copy it before closing
  4. Call the API

    Send Authorization: Bearer akoole_… or X-Api-Key. Optional X-Organisation-Uuid if the key is not already pinned. Edit scopes without rotating; use Rotate secret only when the secret may have leaked. Full request docs: Shop API authentication.

    Show screenshot
    Keys table with Monthly CSV bot, never used yet, and Revoke
    Keys table with Monthly CSV bot, never used yet, and Revoke
Show screenshot
A revoked key stays listed with the Revoked badge
A revoked key stays listed with the Revoked badge
Page missing

Your role lacks Manage API keys. Ask an Owner.

Lost the secret

Revoke or rotate the key and create a new secret. There is no resend.