X-Request-Id

Definição

Header de resposta com um identificador único por requisição; útil para correlacionar logs entre cliente e servidor ao pedir suporte.

`X-Request-Id` é um header de resposta que a API retorna em toda chamada com um identificador único atribuído pelo servidor. É a forma mais simples e robusta de correlacionar o que o cliente vê com o que o servidor registrou internamente. Quando algo falha — um timeout, um `500`, uma validação inesperada — o cliente pode compartilhar o `X-Request-Id` com o suporte e o time da Normadata encontra imediatamente os logs, traces e métricas ligados àquela requisição específica. Formato na Normadata: ULID ou UUID v4. Exemplo de resposta: ``` HTTP/1.1 200 OK X-Request-Id: 01JCKZ8X7HMQVK5R9F2DBN3PWA Content-Type: application/json ``` Recomendações: - Logar o `X-Request-Id` junto a cada resposta da API no cliente (não só em erros). - Incluí-lo em tickets de suporte — economiza horas de busca. - Se seu sistema já gera um trace ID próprio, pode enviá-lo no header de requisição `X-Request-Id`; a Normadata respeita e reflete na resposta para manter a rastreabilidade ponta a ponta. Diferente dos headers `X-RateLimit-*`, este não afeta o comportamento do cliente — é pura observabilidade. Mas é o header que resolve tickets de suporte mais rapidamente quando algo quebra.

Veja também