API keys

1. What is on the screen

At the top, the «Create a key» block with the «Name» field, the «Scopes» («Read» and «Write») and the «Create a key» button. Below, the company's list of keys; if there are none it says «No API keys yet.».

2. Create a key

1. Enter a «Name» that says who uses it (for example, “Payroll ERP” or “management dashboard”).

2. Tick the «Scopes»: «Read» if the system only reads data; add «Write» only if it has to create or change records.

3. Press «Create a key».

4. “Copy this key now — it will not be shown again:” appears. Copy it and store it in the system that will use it; then press “Done”. If you lose it, you will have to create another or rotate it.

3. Rotate, revoke and watch usage

Each key in the list shows its name, its scopes and its “last used”. “Rotate” generates a new value for the same key (the old one stops working) and shows it only once. “Revoke” cancels it immediately and cannot be undone: use it when a system no longer needs it or if you suspect it has leaked. Revoked or expired keys are marked “revoked” or “expired”.

API consumption against your plan's quota is shown in “Integration monitoring”.

4. One key per system

Create a separate key for each system that connects: that way, if one is retired or compromised you revoke only its key and the others keep working, and “last used” tells you which one is active. The key gives access to the whole company's data with the scopes you gave it: keep it in the secrets manager of the system that uses it, never in an email or a spreadsheet.