API Authentication
All Xerobi API requests require authentication to ensure security and proper access control. We support Bearer token authentication with API versioning.Authentication Methods
Bearer Token Authentication
Include your API key in theAuthorization header using the Bearer scheme:
API Keys
Types of API Keys
- Secret Keys: Full access to all API operations. Keep these secure and never expose them in client-side code.
- Publishable Keys: Limited access for client-side operations (e.g., payment form integration).
- Restricted Keys: Scoped access with specific permissions and resource limitations.
Managing API Keys
1
Access your dashboard
Log in to dash.hixbe.com and navigate to the API Keys section.
2
Create a new key
- Click “Create API Key”
- Choose the key type (Secret, Publishable, or Restricted)
- Set permissions and restrictions if applicable
- Add a descriptive name for tracking
3
Secure your keys
- Store keys as environment variables
- Use secret management services (AWS Secrets Manager, Azure Key Vault, etc.)
- Rotate keys regularly
- Never commit keys to version control
API Versioning
All requests must include theXerobi-Version header to specify which API version to use:
Current version:
2026-01-01We recommend always specifying the latest version to access the newest features and improvements.Security Best Practices
Key Security
- Never expose secret keys in client-side code
- Use environment variables for key storage
- Rotate keys every 90 days
- Monitor key usage in your dashboard
- Use restricted keys when possible
Request Security
- Always use HTTPS for all API requests
- Validate SSL certificates
- Implement proper error handling
- Use idempotency keys for critical operations
- Rate limit your requests appropriately
Environment Separation
- Use separate API keys for sandbox and production
- Test thoroughly in sandbox before going live
- Implement environment-specific configurations
- Use different subdomains for testing vs production
Authentication Errors
Common Error Codes
Error Response Format
Testing Authentication
Use our sandbox environment to test authentication without affecting production data:Sandbox and production use separate API keys and data. Always test authentication in sandbox first.
Need Help?
Troubleshooting
Common authentication issues and solutions
Best Practices
Security and integration best practices
API Versioning
Learn about API versioning requirements
Support
Contact our support team