Ir para o conteúdo

Autenticação

A API da Rock Encantech usa OAuth 2.0 Client Credentials para autenticação máquina-a-máquina.


Obter um Access Token

Endpoint

POST /auth/token

Requisição

POST https://api.rockencantech.com.br/auth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
&client_id=SEU_CLIENT_ID
&client_secret=SEU_CLIENT_SECRET
&scope=bnex:read propz:write loyalty:read

Resposta de sucesso

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "bnex:read propz:write loyalty:read"
}
Campo Tipo Descrição
access_token string Token JWT para uso nas requisições
token_type string Sempre "Bearer"
expires_in integer Validade em segundos (padrão: 3600)
scope string Escopos concedidos

Usando o Token

Inclua o token no header de cada requisição:

GET https://api.rockencantech.com.br/v1/customers
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Expiração

O token expira em 1 hora. Implemente lógica de renovação automática antes de expires_in ser atingido. Não faça uma nova autenticação a cada requisição — isso consumirá seu rate limit desnecessariamente.


Escopos disponíveis

Escopo Acesso
bnex:read Leitura de clientes e segmentos
bnex:write Criação e atualização de perfis
propz:read Consulta de campanhas e ofertas
propz:write Criação e gestão de campanhas
loyalty:read Consulta de saldos e extratos
loyalty:write Crédito e débito de pontos

Erros de autenticação

401 Unauthorized

{
  "error": "invalid_token",
  "error_description": "The access token expired"
}

403 Forbidden

{
  "error": "insufficient_scope",
  "error_description": "Token does not have required scope: propz:write"
}

Ambientes

Ambiente Base URL
Produção https://api.rockencantech.com.br
Sandbox https://sandbox-api.rockencantech.com.br

Sandbox

Use o ambiente de sandbox para testes de integração. As credenciais de sandbox são obtidas no painel do desenvolvedor e não afetam dados de produção.