Deu erro na integração? Encontre a chamada no log da API pelo X-Request-Id

"A API devolveu erro" é a frase que mais trava uma integração, porque quase nunca vem com o que foi enviado. Na Sudrel, toda chamada feita com as suas chaves de API fica registrada no painel por 30 dias, com o que o seu sistema mandou e o que a API respondeu. Para achar uma chamada específica, basta um identificador que toda resposta traz.

O identificador que vem em toda resposta

Toda resposta da API traz o cabeçalho X-Request-Id. Os erros de emissão, lote, webhooks e eventos repetem o mesmo valor no corpo, em requisicao_id. Guarde esse valor sempre que uma chamada der errado: é com ele que você, ou o suporte, acha a chamada exata em segundos.

Onde fica e como filtrar

No painel, em Integrações › Log da API. A lista mostra quando, o método, a rota, o status, o tempo de resposta e qual chave fez a chamada. Os filtros:

• requisicao_id: vai direto na chamada.
• Referência da nota: todas as chamadas de uma nota, pelo identificador do pedido no seu sistema.
• Rota, como /v1/nfse.
• Status: um código (404), ou só os erros, ou só os sucessos.
• Período, de e até.

Ao abrir uma chamada, aparecem os dois corpos lado a lado: o enviado e o recebido. É o jeito mais rápido de ver se o valor foi como texto ou como número, se a data foi no formato certo, ou se o campo chegou com outro nome.

O que nunca aparece no log

• Senhas, segredos e tokens: o valor de qualquer campo com nome de credencial vira ***, em qualquer nível do corpo, inclusive a senha do certificado e o segredo do webhook.
• Chaves de API: aparece só o começo, o bastante para saber qual chave foi.
• Arquivos: o certificado e a planilha nunca são gravados, só o nome, o tamanho e uma impressão digital (hash) do arquivo.
• Corpo muito grande é guardado só no começo.

Depois de achar a chamada

O erro traz um codigo estável e, quando dá para repetir, retentavel: true. Programe em cima do código, nunca da mensagem, que é para gente e pode mudar de texto. Repita só o que pode dar certo repetido (429, erro do servidor, tempo esgotado), sempre com a mesma chave de idempotência; não repita erro de validação nem a recusa por empresa não pronta sem corrigir antes. Veja idempotência na emissão por API e como saber se a empresa já pode emitir.

Perguntas frequentes

Por quanto tempo o log da API fica guardado?

Por 30 dias. Cada chamada feita com as chaves de API da conta aparece no painel, em Integrações › Log da API, com o corpo enviado e o recebido.

O que é o X-Request-Id?

É o identificador de cada chamada, devolvido em toda resposta da API. Os erros repetem o mesmo valor em requisicao_id. Com ele você acha a chamada no log do painel.

A senha do certificado fica no log?

Não. Senhas, segredos e tokens são gravados como ***, e arquivos como o certificado nunca são gravados: só o nome, o tamanho e o hash.