Novidades: Alteração importante nos endpoints de baixa de XML e DANFE

Novidades da API da Nuvem Fiscal

Os endpoints de baixa de XML e DANFE da API da Nuvem Fiscal sofrerão algumas mudanças importantes.

Os endpoints BaixarXmlNfce e BaixarPdfNfce, que permitem o download do XML e do DANFCE de uma NFC-e, são alguns exemplos dos endpoints afetados, mas a mudança afeta todos os endpints de download de documentos (XML, PDF, de todo tipo de documento fiscal, de todo tipo de evento).

São duas mudanças importantes:

  1. Esses endpoints agora poderão retornar código de status de HTTP de redirecionamento (302, 307), com a URL do novo endpoint a ser acessado disponibilizado no cabeçalho de resposta Location. Isso é um comportamento comum de redirecionamento na comunicação HTTP. Nesse caso, o cliente HTTP deve fazer uma nova requisição ao endpoint informado no cabeçalho Location, para obter o documento solicitado.

  2. O conteúdo do documento poderá vir compactado, no formato gzip. Se for o caso, isso é informado no cabeçalho de resposta Content-Encoding, que conterá o valor gzip. Nesse caso, o cliente HTTP deve descompactar o conteúdo recebido usando o algoritmo gzip para obter o documento solicitado.

É importante salientar que os procedimentos descritos acima são triviais e padrões nas comunicações HTTP, e a principio você não precisará fazer nenhum procedimento adicional para que o seu uso da Nuvem Fiscal continue funcionando normalmente. A maioria das bibliotecas de desenvolvimento, ferramentas, aplicações, plataformas de desenvolvimento já tratam automaticamente as duas situações acima.

De qualquer forma, estamos alertando sobre essa modificação antecipadamente, pois pode ser necessário algum ajuste manual na sua aplicação.

Ainda, se você usa os SDKs da Nuvem Fiscal, para PHP ou Delphi, nada precisará ser feito. Apenas atualize os SDKs para a última versão.

Se você usa o SDK para .NET, precisará fazer uma pequena alteração, conforme descrito na documentação, e repetida abaixo:

HttpClientHandler httpClientHandler = new HttpClientHandler();
httpClientHandler.AutomaticDecompression = DecompressionMethods.All;
HttpClient httpClient = new HttpClient(httpClientHandler);
var api = new CepApi(httpClient, httpClientHandler);

O novo comportamento será ativado nas seguintes datas:

  • Ambiente de sandbox: a partir de 29 de janeiro de 2024.
  • Ambiente de produção: a partir de 19 de fevereiro de 2024.

Estamos à disposição para quaisquer esclarecimentos.