API Keys Management

The API Keys Management page in OnSefy provides administrators with tools to generate, manage, and revoke API keys for secure authentication and integration with OnSefy services.

Important: The X-Service-Id header parameter is required in API requests when using an API key.

Features#

• Service ID: Unique identifier required for API authentication.
• Generate New API Key: Create up to six API keys for secure access.
• Key Management: Enable, disable, or remove API keys as needed.
• Auto-Replacement: If the limit of six keys is exceeded, the oldest revoked key is automatically deleted.

How to Use#

Generating a New API Key#

1. Enter API Tag: Provide a meaningful label for the key.
2. Click “Generate New API Key”: A new key will be created and displayed.
3. Use the Key Securely: Store the key safely as it will be required for API requests.

Managing API Keys#

• Active Keys: A list of existing API keys is displayed along with their tags.
• Enable/Disable Keys: Toggle the status of API keys.
• Remove Keys: Use the “Disable” button to revoke a key permanently.

Example Use Cases#

• Integrating OnSefy with External Systems: Secure API communication using unique authentication keys.
• Access Control: Assign specific API keys to different services and revoke as needed.
• Security Enforcement: Disable compromised or unused keys to prevent unauthorized access.

Best Practices#

• Keep API keys confidential and do not share them publicly.
• Rotate API keys periodically to enhance security.
• Monitor API key usage and disable any unused or suspicious keys.