Primeiros Passos¶

Guia inicial para time técnico que vai integrar com as APIs da Rock Encantech.

1. Criar credenciais¶

Acesse o painel do desenvolvedor e crie um Client ID e Secret para o seu sistema.

Acesso ao painel

Solicite acesso ao painel para o time de integração: ti@rockencantech.com.br

Cada sistema de integração deve ter credenciais próprias. Não compartilhe o client_secret.

2. Obter o Access Token¶

curl -X POST https://api.rockencantech.com.br/auth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=SEU_CLIENT_ID" \
  -d "client_secret=SEU_CLIENT_SECRET" \
  -d "scope=bnex:read propz:read loyalty:read"

Guarde o access_token e renove-o antes de expires_in segundos.

3. Fazer sua primeira requisição¶

Com o token em mãos, consulte um cliente:

cURLPythonNode.js

curl https://api.rockencantech.com.br/v1/customers \
  -H "Authorization: Bearer SEU_TOKEN"

import requests

token = "SEU_TOKEN"
resp = requests.get(
    "https://api.rockencantech.com.br/v1/customers",
    headers={"Authorization": f"Bearer {token}"}
)
print(resp.json())

const resp = await fetch("https://api.rockencantech.com.br/v1/customers", {
  headers: { Authorization: "Bearer SEU_TOKEN" }
});
const data = await resp.json();
console.log(data);

4. Configurar ambiente de sandbox¶

Use as credenciais de sandbox para testes sem impacto em produção:

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

Dados no sandbox

O sandbox é resetado semanalmente (toda segunda-feira às 03h). Não use como armazenamento permanente.

5. Tratar erros¶

Sempre trate os seguintes cenários:

Código	Ação recomendada
`401`	Renovar o access token
`429`	Implementar exponential backoff
`500`	Registrar o erro e tentar novamente em 30s
`409`	Verificar se o recurso já existe antes de criar