How to generate an API key and use the public API

The Sumtracker API lets your own software, scripts or other tools read and update the data in your Sumtracker account, such as products, stock levels and purchase orders. Every request to the API needs an API key. This article shows how to create one in Sumtracker and where to find the API documentation.

Before you start

  • Permission: you need permission to manage API keys. Account admins have it. If you see "You do not have the required permissions. Please contact your account admin.", ask your account admin to create the key or to give you access.
  • Subscription: you can create API keys during your free trial or on an active subscription.
  • Number of keys: your plan sets how many API keys you can have at a time. Revoked keys don't count toward this limit.

Generate an API key

  1. In Sumtracker, open Settings.
  2. Under Developer, click API Keys.
  3. Click Create New API Key.
  4. Enter a Name that tells you where the key will be used, for example Warehouse ERP sync. The name can be up to 50 characters.
  5. Click Generate API Key.
  6. In the Copy and save the API Key safely window, click the copy icon next to the key and save it somewhere secure, such as a password manager.
  7. Click Dismiss.

⚠️ The full API key is shown only once. After you close the window, Sumtracker can't show it again. If you lose it, revoke the key and generate a new one.

The new key appears in the list on the API Keys page with its Created At date, Name and Prefix. The prefix is the first part of the key. Use it to tell which key an integration is using without exposing the full key.

Revoke an API key

Revoke a key when you stop using an integration, or straight away if you think the key has leaked.

  1. Go to Settings → API Keys.
  2. In the Actions column, click the bin icon next to the key.
  3. Click OK to confirm.

Any integration that uses the key stops working immediately. A revoked key can't be restored, so generate a new key if you need access again.

Use your API key

Send your API key in the Authorization header of every request, with Api-Key and a space in front of it:

Authorization: Api-Key YOUR_API_KEY

The full API documentation is at developers.sumtracker.com. It covers the base URL, the API versions, every endpoint with its fields and filters, the rate limit, and a playground where you can try requests with your key. You can also open it from the View API Docs button on the API Keys page.

Keep your API key safe

  • An API key can read and change the data in your Sumtracker account, so treat it like a password.
  • Don't share it by email or chat, and never put it in website or mobile app code where others can see it.
  • Give each integration its own key, so you can revoke one without breaking the others.
  • If a key may have leaked, revoke it and generate a new one.

Still need help? Contact Us Contact Us