API Rest
A API Rest permite que se tenha acesso a vários Endpoints para o serviço de recebimento dos documentos fiscais, NF-e / CT-e.
A API Rest usa Authorization Basic
.
Username:
CNPJ
Password:
TOKENO TOKEN pode ser obtido acessando o aplicativo em Configurações -> Meus Dados. Na aba dados complementares, clicar em Gerar Token.
401 Falta a Authorization Basic
no header.
404 CNPJ / Token inválidos (gerar novo token, se necessário).
{"error":"TOKEN not found"}
Endpoint /NFe
Obter o XML individualmente:
GET
https://mde.app.br/api/v1/NFe/xml?chave=
{chavedanfe}
200 O retorno será um arquivo MIME/XML da NF-e solicitada.
204 O retorno será um arquivo MIME/JSON de Aviso, que existe o resumo da NF-e, mas ainda não foi disponibilizado o XML da NF-e solicitada.
{"warning":"XML not downloaded yet"}
404 O retorno será um arquivo MIME/JSON de Erro informando que ainda não existe o resumo da NF-e solicitada.
{"error":"NFe not found"}
Obter o RESUMO das notas disponíveis pela Data de Emissão:
GET
https://mde.app.br/api/v1/NFe/resumo?emissao=
{datadeemissao}{datadeemissao} deve ser no formato:
ddmmaaaa
Obter o RESUMO das notas disponíveis pela Competência:
GET
https://mde.app.br/api/v1/NFe/resumo?competencia=
{datacompetencia}{datacompetencia} deve ser no formato:
mmaaaa
200 Exemplo do MIME/JSON retornado:
Onde:
"emissao"
- Data de Emissão da NF-e no formato (dd/mm/aaaa).
"hora"
- Horário de Emissão da NF-e no formato (hh:mm:ss).
"cnpj"
- CNPJ / CPF do emissor da NF-e.
"nome"
- Nome do emissor da NF-e.
"tipo"
- Tipo da NF-e, onde [0-Entrada | 1-Saída].
"situacao"
- Situação da NF-e, onde [0-Autorizada | 1-denegado | 2-Cancelada | 3-Encerrada ].
"evento"
- Último evento manifestado, onde [3-Confirmação | 4-Ciência | 5-Desconhecimento | 6-Não Realizada ].
"valor"
- Valor da NF-e.
"chave"
- Chave da NF-e.
"xml"
- Tem XML disponível, onde ["S" - Sim | "N" - Não].
Obter os XMLs das notas em arquivo ZIP, pela Data de Emissão:
GET
https://mde.app.br/api/v1/NFe/zip?emissao=
{datadeemissao}{datadeemissao} deve ser no formato:
ddmmaaaa
Obter os XMLs das notas em arquivo ZIP, pela Competência:
GET
https://mde.app.br/api/v1/NFe/zip?competencia=
{datacompetencia}{datacompetencia} deve ser no formato:
mmaaaa
200 O retorno será um arquivo MIME/ZIP com todos os XMLs do período.
Em desenvolvimento...