Setting up API Key
Generate and configure API keys to authenticate your applications with Cipherion's encryption services.
Prerequisites
Ensure your project is created and you have the necessary permissions to generate API keys.
API Key Generation Process
Navigate to Credentials Section
Access the API key management interface
- Go to your project dashboard in the Cipherion console
- Navigate to "Credentials" → "API Keys"
- Click "Generate New API Key" button
Configure Key Permissions (Coming Soon...)
Set appropriate scopes and permissions for your API key
Key Name and Description
Product API Key
Key used for production environment encryption operations
Key Permissions
- Encrypt Data (Required)
- Decrypt Data (Required)
- Tokenize Data
- Detokenize Data
- Generate Reports
- Access Audit Logs
Environment
Select Environment
Rate Limits
Requests per minute
1000
Daily request limit
100000
Generate and Secure Your Key
Create your API key and store it securely
Click the button below to generate your API key. Make sure to copy and store it securely as it will only be shown once.
Important
Your API key will only be displayed once. Make sure to copy it and store it in a secure location.
Generated API Key:
cph_sk_live_1234567890abcdefghijklmnopqrstuvwxyzConfigure Environment Variables
Set up your application environment
# .env file
CIPHERION_API_KEY=your_api_key_here
CIPHERION_PROJECT_ID=proj_abc123def456ghi789
CIPHERION_ENVIRONMENT=production
# Optional: API endpoint
CIPHERION_API_ENDPOINT=https://api.cipherion.comSecurity Best Practices
- Use environment variables to store API keys
- Never hardcode API keys in your source code
- Use different keys for different environments
- Regularly rotate your API keys
- Monitor API key usage and set up alerts
Troubleshooting
Common issues and solutions
401 Unauthorized Error
Check that your API key is correctly formatted and has the required permissions.
429 Rate Limit Exceeded
You've exceeded your rate limits. Consider implementing exponential backoff or contact support to increase limits.
403 Forbidden
Your API key doesn't have permission for this operation. Review and update key permissions.