APIs¶
Referência técnica das APIs da Rock Encantech. Todos os endpoints seguem o padrão REST e retornam JSON.
Base URL¶
Versão atual¶
| API | Versão | Status |
|---|---|---|
| Bnex — Clientes | v1 |
Estável |
| Propz — Campanhas | v1 |
Estável |
| LL Loyalty — Pontuação | v1 |
Estável |
| Bnex — Segmentos | v2 |
Beta |
Autenticação¶
Todas as requisições exigem autenticação via Bearer Token (OAuth 2.0).
:octicons-arrow-right-24: Ver documentação de autenticação
Convenções¶
Formato de datas¶
Todas as datas seguem ISO 8601 no fuso America/Sao_Paulo:
Paginação¶
Endpoints de listagem usam cursor-based pagination:
{
"data": [...],
"pagination": {
"next_cursor": "eyJpZCI6MTAwfQ==",
"has_more": true,
"total": 4523
}
}
Códigos de status¶
| Código | Significado |
|---|---|
200 |
Sucesso |
201 |
Recurso criado |
400 |
Requisição inválida |
401 |
Não autenticado |
403 |
Sem permissão |
404 |
Recurso não encontrado |
409 |
Conflito (ex: duplicidade) |
422 |
Erro de validação |
429 |
Rate limit atingido |
500 |
Erro interno |
Rate Limit¶
| Plano | Requisições/minuto |
|---|---|
| Standard | 300 |
| Enterprise | 3.000 |
O header X-RateLimit-Remaining informa quantas requisições restam na janela atual.