Appearance
API keys
Platform settingsAccessAPI keysPermission:
settings.integrations.vieworsettings.integrations.manageOpen in Roari ERP (new tab)Also known as
- API
- API key
- token
- bearer token
- access token
- integration
- REST API
- connector
- machine user
- service account
An API key lets another system (an e-commerce shop, a BI tool, a script) call the Roari ERP API without a user signing in. Each key has its own permissions, chosen when you create it, and acts with those permissions only, not with a user's. Administrators create one key per integration.
See your keys
Go to SettingsAPI keys. For each key you see:
| Column | Meaning |
|---|---|
| Name | What the key is for. |
| Key | The first characters of the key (erp_…), to recognise it in the integration's settings. The full key is never shown again. |
| Permissions | How many permissions the key holds. Hover the number to list them. |
| Last used | When an integration last called the API with it; Never if not yet. |
| Expires | The expiry date, Never, or a red Expired … tag. |
| Created | When the key was created. |
Create a key
- Select New API key.
- Fill in the dialog (see the table) and select Create key.
- The dialog “…” is ready shows the full key once. Select Copy, paste it into the integration's secret settings, then select I have stored the key (Done after copying).
You won’t see this key again
Roari ERP stores only a hash of the key. If it is lost, revoke it and create a new one.
| Field | Required | What to enter |
|---|---|---|
| Name | Yes | The integration, for example Shopify connector. Empty: Enter a name. |
| Permissions | Yes | Only what the integration needs; search by name or key. The key can do only these things, whoever uses it. You can grant only permissions you hold yourself. Empty: Grant at least one permission. |
| Expires | No | The last day the key works. Leave empty (Never) for a key that never expires; rotate long-lived keys yearly. Must be in the future. |
Use a key
The integration sends the key in every request header:
http
Authorization: Bearer erp_…Requests run inside your organisation with the key's permissions. A key cannot create other API keys or change passwords. Every change it makes is recorded in the audit trail.
Revoke a key
- Select the bin icon at the end of the key's row.
- Confirm Revoke key in Revoke “…”?. You see “…” revoked.
Requests using the key are refused from now on; the integration stops working until it gets a new key. To rotate a key, create the new one, update the integration, then revoke the old one.
Differences by role
- Viewing keys needs Permission:
settings.integrations.view; creating and revoking them needsPermission:settings.integrations.manage. Account admin users can always do it.
Related
- Webhooks: push events to other systems
- Roles and permissions
- Import and export
- Audit trail
- Tenant administration
