Skip to Content
Welcome to Zendera Knowledge Hub
API DocumentationAuthentication

Authentication

Learn how to authenticate with the Zendera API using API key authentication for secure access to our services.

Authentication

Authorization: apikey YOUR_API_KEY_HERE

Base URLs

  • Production: https://app.zenderatms.com/api/
  • Staging: https://staging.zenderatms.com/api/

Getting Your API Key

Log in to Dashboard

Access your Zendera dashboard with your account credentials

Go to Settings > API Keys in the admin interface

Generate New Key

Click Generate New Key and provide a descriptive name

Store Securely

Copy and securely store your API key - it won’t be shown again

Example Usage

cURL Example

curl -X GET "https://app.zenderatms.com/api/v2/orders/summary/ORDER_123" \
  -H "Authorization: apikey YOUR_API_KEY"

JavaScript Example

const response = await fetch('https://app.zenderatms.com/api/v2/orders/summary', {
  headers: {
    'Authorization': 'apikey YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});

Python Example

import requests
 
headers = {
    'Authorization': 'apikey YOUR_API_KEY',
    'Content-Type': 'application/json'
}
 
response = requests.get('https://app.zenderatms.com/api/v2/orders/summary', headers=headers)

Security Best Practices

Storing API Keys:

  • Never commit API keys to version control
  • Use environment variables in your applications
  • Rotate keys regularly (recommended: every 90 days)
  • Use different keys for different environments

Environment Variables

# .env file
ZENDERA_API_KEY=your_api_key_here
// In your application
const apiKey = process.env.ZENDERA_API_KEY;

Error Handling

Common authentication errors:

401 Unauthorized

{
  "error": "Invalid API key",
  "code": "AUTH_001"
}

Solution: Check your API key is correct and active.

403 Forbidden

{
  "error": "Insufficient permissions",
  "code": "AUTH_002"
}

Solution: Ensure your API key has the required permissions.

Rate Limiting

API keys are subject to rate limiting:

  • Standard: 1000 requests per hour
  • Premium: 10,000 requests per hour
  • Enterprise: Custom limits

Rate limit headers are included in responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Next Steps

Last updated on
OverviewOrders