Resolução de Problemas

📘

Consulta de informações

Antes de prosseguir com a resolução de problemas, certifique-se que você armazene o campo request-id do método para que a equipe de suporte possa tratar o cenário e as condições que foram aplicadas no momento da requisição. Isso facilita a nossa equipe.

Essa seção aborda em diferentes cenários etapas condicionais para a integração do seu sistema com o nosso. Pensando nisso, averigue-se o seu erro é:

Erros de Conectividade e Protocolo

Antes de validar o corpo da requisição, certifique-se de que a camada de transporte está correta;

1. Verifique o Protocolo: Nossa API aceita exclusivamente conexões via HTTPS. Requisições via HTTP puro serão rejeitadas ou redirecionadas;
2. Cabeçalho Content-Type: Certifique-se de enviar Content-Type: application/json em todas as requisições POST, PUT ou PATCH.
3. DNS e Firewall: Confirme se o seu ambiente de rede permite chamadas de saída para o domínio api.seusistema.com.

Autenticação e Autorização (JWT)

Problemas relacionados ao cabeçalho Authorization:

1. Token Expirado (401 Unauthorized): Verifique o campo exp no payload do seu JWT. Se o token expirou, você deve gerar um novo;
2. Escopo Insuficiente (403 Forbidden): Seu token é válido, mas não possui permissão para o recurso acessado. Verifique se o seu usuário possui a role necessária (ex: admin, write);
3. Formato do Prefixo: O cabeçalho deve seguir exatamente o padrão Bearer <token>. Erros de digitação ou ausência do espaço após "Bearer" causarão falha na validação.

Como debugar uma requisição específica?

Sempre que entrar em contato com o suporte, por favor, forneça o Request ID encontrado no corpo da resposta:

{
  "success": true,
  // Dados vão aqui
	"data": {},
  "meta": {
    "request_id": "c9d911a41d7bc806696be43c4410e65a", // Identificador da requisição
    "timestamp": "2026-01-01T15:25:55.249438496Z" // RFC 3339
  }
}

Isso nos permite localizar exatamente o que aconteceu nos nossos logs internos.