Authentication
Use this section to understand how to authenticate with Salesbox’s API.
Base URL
https://segmentai.salesbox.com.br/api
Authentication Methods
The API supports authentication via API tokens.
API Token Authentication
To authenticate your requests, include your API token in the Authorization header:
Authorization: Bearer YOUR_API_TOKEN
Example Request
curl -X GET https://segmentai.salesbox.com.br/api/contacts \
-H "Authorization: Bearer YOUR_API_TOKEN"
Getting an API Token
Log in to your Salesbox account
Go to Settings > API Tokens
Click “Generate New Token”
Give your token a name and select the permissions
Copy and save your token securely
Token Security
Keep your API token secure and never share it
Rotate tokens regularly
Use different tokens for different applications
Revoke compromised tokens immediately
Rate Limiting
The API has rate limiting to protect the service:
Plan |
Rate Limit |
Period |
|---|---|---|
Basic |
1000 requests |
per hour |
Professional |
5000 requests |
per hour |
Enterprise |
10000 requests |
per hour |
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response.
Error Responses
Status Code |
Description |
|---|---|
|
Invalid or missing API token |
|
Valid token but insufficient permissions |
|
Rate limit exceeded |
Example Error Response
{
"error": {
"code": "unauthorized",
"message": "Invalid API token provided",
"status": 401
}
}