Suporte

O que incluir num report de API

Para que o time localize sua requisição nos logs, inclua sempre:

Item	Onde encontrar
`request_id`	Header de resposta `x-request-id`, campo `instance` do erro (`/v1?request_id=<id>`) ou campo `request_id` do body
Timestamp	Data e hora da requisição (com fuso horário)
Endpoint	Método e rota chamados (ex.: `POST /analyses` ou `POST /operations`)
`code` do erro	Campo `code` do body de erro (ex.: `server_error`)
Body do erro	O JSON completo da resposta, se possível
`id` da análise/operação	Quando o problema é em um run específico (resultado inesperado, `failed`)

Todo erro da API segue o formato RFC 7807 e traz esses campos:

{
  "type": "https://docs.sherlocker.com.br/problems/server_error",
  "title": "Internal Server Error",
  "status": 500,
  "code": "server_error",
  "detail": "...",
  "instance": "/v1?request_id=req-uuid-here"
}

Você pode enviar seu próprio x-request-id no header da requisição. Se não enviar, o servidor gera um UUID. Em ambos os casos o valor é ecoado no header de resposta x-request-id — registre-o nos seus logs para facilitar o suporte.

Começando

Conceitos

Motor de CPF/CNPJ

Motor de Borderô (títulos & NFe)

Referência comum

Acesso e suporte

O que incluir num report de API

Relacionado

Erros da API

Solicitar acesso à API

​O que incluir num report de API

​Relacionado

Erros da API

Solicitar acesso à API

O que incluir num report de API

Relacionado