Creating API Keys
To create a new Orcabase API key, follow these steps:
- Navigate to Developer App >API Keys.
- Click Create API Key.
- A popup will display your new API key.
Important:
- Copy and securely store your API key immediately.
- Once the popup is closed, the API key cannot be retrieved again.
Managing API Keys
After creating one or more API keys, you can manage them on the API Keys page. API keys are stored and displayed per user.
To revoke an API key:
- Locate the API key you wish to revoke.
- Click the trash icon next to the key and click OK in the confirmation popup.
Revoking an API key is permanent and cannot be undone.
Testing Your API Key
To validate your API key, send a request to the Validate API Key endpoint.
Best Practices for API Keys
- Keep your API key confidential: Treat your API key as securely as a password. Never share it publicly or expose it in your code repositories.
- Rotate your keys regularly: Periodically regenerate your API keys to reduce security risks.
- Monitor usage: Track API key usage and revoke any keys you suspect may have been compromised.