Debug
A funcionalidade de debug da API da Nuvem Fiscal permite analisar a comunicação realizada com os servidores da SEFAZ ou prefeituras durante as transmissões de documentos fiscais. Com ela, é possível coletar os envelopes SOAP (requisição e resposta) e outras informações técnicas úteis para diagnóstico de falhas e abertura de chamados.
Quando usar o fluxo de debug?
- Listar os eventos técnicos registrados durante o envio de documentos
- Visualizar e decodificar os envelopes de requisição e resposta
- Identificar erros de schema ou falhas na comunicação com a SEFAZ/prefeitura
- Analisar o conteúdo das transmissões em casos de rejeição ou problemas sistêmicos
- Gerar evidências para envio ao suporte técnico à Nuvem Fiscal ou aos órgãos autorizadores (SEFAZ/prefeitura)
Exemplo de fluxo de uso
- Identifique o ID do documento fiscal (ex: nfe_3a196d092d3a42c3a1f83706a47eb64c)
- Chame o endpoint Debug de DF-e informando o ID do documento fiscal
- Caso queira verificar o payload recebido pela Nuvem Fiscal no momento da emissão do documento fiscal, utilize o endpoint Payload original recebido
- Na resposta do endpoint Debug de DF-e, identifique o ID da requisição HTTP que queira inspecionar
- Chame o endpoint Corpo da requisição HTTP para obter o conteúdo enviado ao autorizador (geralmente um envelope SOAP)
- Chame o endpoint Corpo da resposta HTTP para obter o conteúdo recebido do autorizador (geralmente um envelope SOAP)
- Encaminhe esses arquivos ao suporte da SEFAZ ou prefeitura, se necessário
Autenticação e escopo necessário
Todas a requisições à API devem ser autenticadas usando um token de acesso contendo o scope debug.
Consulte a referência à API para Debug para saber mais sobre todos os endpoints disponíveis.