Managing API Keys

To connect custom applications or backend databases to Omnix, you must generate an API key.

1. Generating an API Key

1. Go to Settings → Admin → API Keys.
2. Click Generate API Key.
3. Set the key parameters:
   • Label: Describe the integration (e.g. Corporate CRM Connector).
   • Permissions: Set whether the key has read-only or read/write access.
4. Click Generate.
5. Copy the generated key. This is the only time the key is displayed. Save it securely.

2. API Key Rotation and Deactivation

If an API key is compromised or no longer needed:

• Deactivate: Click the toggle next to the key to disable it immediately. You can re-enable it later.
• Revoke / Delete: Click the trash icon to permanently remove the key. Any application using this key will immediately receive HTTP 401 Unauthorized errors.
• Rotation: Generate a new API key, update your integration code, and then revoke the old key.

Related Developer Guides

• API Authentication (Developers) — Headers and security practices.
• Error Handling (Developers) — Token verification errors.