Skip to main content

Best Practices

Follow these best practices when integrating with Cambrionix Connect APIs.

Authentication​

  • Store credentials securely: Never commit API credentials to version control
  • Use environment variables: Store credentials in environment variables or secret management systems
  • Rotate credentials: Regularly rotate API keys and secrets
  • Token caching: Cache access tokens and refresh before expiration

Request Handling​

  • Use HTTPS: Always use HTTPS for all API requests
  • Set timeouts: Configure appropriate request timeouts
  • Handle errors: Implement comprehensive error handling
  • Retry logic: Use exponential backoff for retries

Performance​

  • Pagination: Always use pagination for list endpoints
  • Caching: Cache frequently accessed data
  • Batch operations: Use batch endpoints when available
  • Async processing: Process webhooks and callbacks asynchronously

Rate Limits​

  • Monitor headers: Check rate limit headers in responses
  • Respect limits: Implement backoff when rate limits are exceeded
  • Request increases: Contact support if you need higher limits

Security​

  • Input validation: Validate and sanitize all user input
  • Output encoding: Encode output to prevent injection attacks
  • HTTPS only: Never make requests over HTTP
  • Secret management: Use secure secret management systems