Create and manage API keys

API keys let other systems — biometric machines, custom scanners, access-control systems or another HR tool — send data to Attendex. This article shows you how to create a key, keep it safe and watch how it is used.

Before you start

• Your plan must include API & Integrations.
• You need the API dashboard & keys permission (under Developer & API). Administrators have it by default.
• An API key can act for your whole company. Treat it like a password.

Create an API key

1. In the left menu, under Insights, click API & Integrations ( open API & Integrations).
2. In the Active API credentials card, click Generate API Key.
3. Enter a Key Label Name that says where the key is used, for example "Biometric Machine Office A".
4. Set the Rate Limit (Calls per Minute). The default is 60.
5. Optionally enter an IP Whitelist — a comma-separated list of the only IP addresses allowed to use the key.
6. Optionally enter an IP Blacklist — IP addresses that must never use the key.
7. Click Generate Key.
8. Click Copy next to the new key and store it somewhere safe, such as your integration's settings or a password manager.

Manage your keys

The Active API credentials table lists each key's Key Name, the start of its API Key Token, its Rate Limit, IP Security (Whitelist Active or Blacklist Active) and Status.

• Turn a key off temporarily: click its Active button. It changes to Inactive and calls with that key are refused. Click again to turn it back on.
• Delete a key: click the bin icon and confirm. Any application still using it stops working immediately.

Monitor API usage

The top of the page shows:

• Total API Calls (7 Days), Average Latency and Success Rate.
• Daily Call Volume — a chart of calls per day.
• Error Code Distribution — which errors your integrations are getting.

The API Help & Documentation card at the bottom has an Overview, the Mark Attendance API reference and Code Examples in JavaScript, Python and cURL. See Send punches with the Mark Attendance API.