​

Authentication

​

Getting an API Key

1. Log in to your ZenFlow Dashboard
2. Navigate to Settings > API Keys
3. Click Create API Key
4. Configure your key:
   • Name: A descriptive name (e.g., “ERP Integration”)
   • Scopes: Select the permissions your key needs
   • Expiration: Optional expiration date
5. Click Create
6. Copy your API key immediately - it won’t be shown again

​

Using Your API Key

curl -X GET "https://api.zenflow.com.ar/api/v1/orders" \
  -H "X-API-Key: zenflow_live_abc123..."

const response = await fetch("https://api.zenflow.com.ar/api/v1/orders", {
  headers: {
    "X-API-Key": "zenflow_live_abc123...",
  },
});

import requests

response = requests.get(
    'https://api.zenflow.com.ar/api/v1/orders',
    headers={'X-API-Key': 'zenflow_live_abc123...'}
)

​

API Key Format

zenflow_live_<random_string>
zenflow_test_<random_string>

• zenflow_live_*: Production keys
• zenflow_test_*: Test/sandbox keys (coming soon)

​

Scopes

​

Scope Presets

​

Error Responses

​

Invalid API Key

{
  "success": false,
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or has been revoked"
  }
}

​

Missing API Key

{
  "success": false,
  "error": {
    "code": "missing_api_key",
    "message": "API key is required. Include it in the X-API-Key header"
  }
}

​

Insufficient Permissions

{
  "success": false,
  "error": {
    "code": "insufficient_scope",
    "message": "This API key does not have the required scope: write:orders"
  }
}

​

Expired API Key

{
  "success": false,
  "error": {
    "code": "expired_api_key",
    "message": "This API key has expired"
  }
}

​

Security Best Practices

​

Example: Environment Variables

# .env file (never commit this!)
ZENFLOW_API_KEY=zenflow_live_abc123...

// Node.js
const apiKey = process.env.ZENFLOW_API_KEY;

# Python
import os
api_key = os.environ.get('ZENFLOW_API_KEY')

​

Rotating API Keys

1. Create a new API key with the same scopes
2. Update your application to use the new key
3. Verify the new key is working
4. Revoke the old key

​

IP Whitelisting (Optional)

1. Go to Settings > API Keys
2. Select your API key
3. Add allowed IP addresses or CIDR ranges
4. Save changes

{
  "ip_whitelist": ["192.168.1.100", "10.0.0.0/24"]
}

​

Rate Limits