Integration API keys

Who can do thisTenant Admin

The SecurityAPI keys page (titled Integration API keys) lets you create machine-to-machine credentials for your own integrations, such as an ERP export or a partner connector. Each key belongs to this workspace only and may reach only the products you choose. Revoking a key disables it at once.

Which products a key can reach

Only three products are offered for API keys today. In the dialog each one is shown by its short product key with a description under it:

• wms, Warehouse Management System: inventory, receiving, picking, shipping.
• procurement, Supplier Relationship Management: suppliers, requisitions, purchase orders.
• ams, Asset Management System: the asset register and lifecycle tracking.

Keys for other products, such as Helpdesk or HR Management, cannot be created here.

Generate a key

1. Click Generate API key.
2. In Label *, type a name you will recognise later, for example "ERP export".
3. Under Products *, tick at least one product.
4. Click Generate.

A missing label gives "A label is required."; no product ticked gives "Pick at least one product."

Copy the secret now: it is shown once

The card API key created shows four values: Client ID, Client secret, Token endpoint and Resource. Your integration uses them to request an access token, which it then sends with its calls.

1. Click Copy credentials (it changes to Copied!) and store the values in your integration or a password vault.
2. Click Dismiss when you are done.

The list of keys

An empty list says No API keys yet.

Revoke a key

1. Click Revoke on the key's row.
2. The dialog Revoke API key names the key and its Client ID, and warns: "The credential stops working immediately - any integration using it will start failing. This cannot be undone."
3. Confirm with Revoke.

The row stays in the list with the status revoked and the date it was revoked. A revoked key cannot be turned back on. If the integration still needs access, generate a new key and update the integration.