API Keys
Generate an API key so you can create Access Token and make requests to our API.
API keys are essential for accessing our services. In our system, there are two types of API keys:
- Tenant Keys: Designed for managing tenant-level operations.
- Customer Keys: Specifically tailored for customer-related activities.
Each API key consists of two components: Client ID and Client Secret.
Both parts are required to generate an access token for the API. Treat these credentials with the utmost care to maintain the security of your application and data.
Tips for Safely Handling API Keys
- Keep Secrets Confidential: Never expose the Client Secret in client-side code or public repositories.
- Use Environment Variables: Store API keys in environment variables or secure configuration files rather than hardcoding them in your application.
- Limit Permissions: Assign API keys the minimum level of access/roles required for their intended purpose.
- Revoke Compromised Keys: If you suspect an API key has been exposed, revoke it immediately and generate a new one.
Updated over 1 year ago
Did this page help you?