API GaxDfe - Baixar documento único ou em lote do GaxWeb.

Endpoint:

https://app.nssoft.com.br/webservice/gaxdfe/monitor/zip/

Parâmetros:

>> modelo 55, 57, 59, 65 ou 67

Ex: modelo=55

>> empresa CPF/CNPJ da empresa (somente números)

Ex: empresa=12345678000123 

>> data de emissão no formato YYYY-mm-dd (Ano-mês-dia)

Ex: emissao=2022-12-30

>> período (à partir de)

48h => Últimas 48 horas

7d => Últimos 7 dias

15d => Últimos 15 dias

0m => Mês atual

1m => Mês anterior

2m => Últimos 2 meses

3m => Últimos 3 meses

4m => Últimos 4 meses

5m => Últimos 5 meses

6m => Últimos 6 meses

1y => Ano atual

2y => Últimos 2 anos

3y => Últimos 3 anos

4y => Últimos 4 anos

5y => Últimos 5 anos

Ex: periodo=48h

eventos

true ou false 

Exporta eventos do documento (somente zip)

-- 

Ex: eventos=true

pdf 

true ou false 

Exporta PDF do documento (somente zip) 

-- 

Ex: pdf=true 

Exemplos:

Chave Única (35250192791243002157550020004685301267323702)

É necessário enviar o header "appkey: {APPKEY}" na requisição

exemplo cmd:

curl https://app.nssoft.com.br/webservice/gaxdfe/nfe/{CHAVE}/zip -H "appkey: {APPKEY}"

Lote NFe mod 55 dos últimos 2 meses da empresa sem eventos

exemplo cmd:
curl https://app.nssoft.com.br/webservice/gaxdfe/monitor/zip?modelo=55&periodo=2m&empresa=12345678000123 -H "appkey: {APPKEY}"

Lote NFe mod 55 dos últimos 2 meses da empresa com eventos

Eventos true exporta eventos do documento (somente zip)

exemplo cmd:

curl https://app.nssoft.com.br/webservice/gaxdfe/monitor/zip?modelo=55&periodo=2m&empresa=12345678000123&eventos=true -H "appkey: {APPKEY}"

Retorno:

Em caso de sucesso retornará HTTP 200 e o arquivo anexo, neste caso continue enviando requisição até que não encontre mais documentos para baixar então retornará HTTP 204, significando que para esta requisição não há mais arquivos à serem baixados.

Como as requisições retornam a quantidade máxima de 1000 arquivos por solicitação, deve-se então efetuar requisições até que o retorno seja HTTP 204.

Erros:

Quaisquer erros de permissão retornará HTTP 403 (Forbidden)

Demais erros retornará HTTP 400 e a mensagem de erro.

Importante:

A APIKEY esta disponivel em terminal criado no menu aplicações >> GaxDFe.

Os arquivos baixados são automaticamente registrados na lista de download e não serão baixados novamente em nova requisição, portanto atenção ao baixar para não remover ou perder o arquivo baixado. Caso precise baixar novamente deve-se fazer contato com suporte atraves do chat e solicitar desbloqueio dos arquivos ja baixados.

Att

Equipe NSSoft