Create an evidence API key
Create a read-only key with the scopes your management platform needs, rotate it or revoke it.
Before you start
You need to be a company administrator.
Steps
Go to Settings → Evidence API and webhooks.
In API keys, click New key.
Type the Name (for example, "SofIA Gestión").
In Scopes, check only what the platform needs to read.
In Restrictions, choose when it Expires in: 90 days, 180 days, 1 year, 2 years or No expiration.
If you want the key to read only what a role sees, choose the role in Limit to a role's scope. Otherwise, leave The whole company.
If you want to limit where it is used from, check Only from some IPs or networks and add each IP or network (for example, 200.1.2.3 or 10.0.0.0/8) with Add IP or network.
Click Create.
Copy the Key and give it to the management platform. Click Done.
The key is shown only once. ARGUNIS cannot show it again.
Key statuses
Status | What it means |
|---|---|
valid | It works |
expires soon | It expires in less than 30 days |
rotating | It already has a new key replacing it |
expired | It is past its expiration |
revoked | It stopped working |
In the table you also see its scopes, which IPs are allowed, its last use (with the IP) and how many requests it made in 24 hours. Click Show revoked to include revoked keys.
Rotate
Click Rotate in the key's row.
Specify how many hours the current key stays valid in The current key stays valid for (hours).
Confirm and copy the new key.
A new key is created with the same scopes; the current one expires when the period ends.
Revoke
Click Revoke and confirm with Revoke. The next request with that key will fail, and this cannot be undone.