Compressão gzip

Alguns métodos da Qprof API podem trafegar grande volume de dados. Para otimizar a velocidade da chamada e da resposta, esses métodos exigem o corpo da requisição comprimido em gzip — e, em alguns casos, retornam o conteúdo em gzip + Base64.

Quando usar

Os endpoints que exigem compressão estão sinalizados na própria descrição com o aviso:

⚠️ Compressão obrigatória: o corpo desta requisição (JSON) deve ser enviado comprimido em gzip.

Endpoints que usam gzip no corpo (referência):

Método	Endpoint
POST	`/servicos/operacao/importarOperacao`
POST	`/servicos/operacao/importarOperacaoCnab`
POST	`/servicos/operacao/simularOperacao`
POST	`/servicos/operacao/gerarInstrucao`
POST	`/servicos/cobranca/InserirOcorrenciaCobrancaTitulo`
POST	`/servicos/controladoria/receberStatusNfe`
PUT	`/servicos/controladoria/AtualizarStatusChecagemTitulo`
POST	`/servicos/controladoria/InserirOcorrenciaControladoriaTitulo`

Como enviar (requisição)

Monte o corpo como JSON normalmente.

Comprima o JSON em gzip.

Envie os bytes comprimidos no corpo, com o cabeçalho de conteúdo apropriado.

Exemplo (cURL)

Como ler a resposta (gzip + Base64)

Alguns métodos retornam o conteúdo compactado em gzip e codificado em Base64 (ex.: emissão de boletos, instruções a regularizar, arquivos de retorno do cedente). Para ler:

Faça Base64 decode do corpo da resposta.

Descomprima (gunzip) os bytes resultantes.

O resultado é o JSON final.

Observações no Apidog

Na documentação, o tipo do corpo aparece como application/json (para exibir o JSON legível), mas no envio real o corpo deve ser comprimido conforme acima.

Ao testar pelo Apidog, gere o gzip do corpo antes de enviar (ou use um Pre-Processor/script para comprimir).

Compressão gzip

Quando usar#

Como enviar (requisição)#

Exemplo (cURL)#

Como ler a resposta (gzip + Base64)#

Observações no Apidog#

Quando usar

Como enviar (requisição)

Exemplo (cURL)

Como ler a resposta (gzip + Base64)

Observações no Apidog