API keys
An API key gives external systems access to your organization's data: 1C, a BI dashboard, your own website, or any other integration a developer builds. The key isn't for employees - it's for programs that talk to Smengo directly.
Where to create a key
Anyone with the "Manage organization" permission can manage keys - typically the owner. You'll find the section under "Settings" → "Integrations" → the "API keys" block.
How to create a key
- Click "Create key".
- Enter a name - it's just for you, to tell keys apart later (for example, "1C integration").
- Choose the access (scopes) - which data the key can read: employees, schedule, check-ins, timesheets, or demand/revenue. Only select what the integration actually needs.
- Optionally set a requests-per-minute limit (60 by default).
- Click "Create".
A key can only be granted access to data you can see yourself - if you don't have a permission, the key can't have it either.
Copy the key right away - it won't be shown again
Right after creation, the key is shown on screen exactly once. Click "Copy" and save it somewhere safe before closing the window. Smengo only stores an encrypted fingerprint of the key - it can't be shown again, only revoked and replaced with a new one.
The key is a secret, just like a password. Don't post it publicly, send it in open chats, or paste it into code that anyone else can see. Share it only with whoever is building the integration, over a secure channel.
Revoking a key
You can revoke a key at any time with the "Revoke" button in the list - every request made with it stops working immediately. Revoke a key when the integration is no longer needed, or if you suspect it may have leaked.
For developers
Technical details - the key format, all available scopes, endpoints, and example requests - live in the API documentation. You can share that link with whoever is building the integration.