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 /CTe
Obter o XML individualmente:
GET
https://mde.app.br/api/v1/CTe/xml?chave={chavedocte}
200 O retorno será um arquivo MIME/XML do CT-e solicitado.
204 O retorno será um arquivo MIME/JSON de Aviso, que existe o resumo do CT-e, mas ainda não foi disponibilizado o XML do CT-e solicitado.
{"warning":"XML not downloaded yet"}
404 O retorno será um arquivo MIME/JSON de Erro informando que ainda não existe o resumo do CT-e solicitado.
{"error":"CTe not found"}
Obter o RESUMO dos conhecimentos disponíveis pela Data de Emissão:
GET
https://mde.app.br/api/v1/CTe/resumo?emissao={datadeemissao}{datadeemissao} deve ser no formato:
ddmmaaaa
Obter o RESUMO dos conhecimentos disponíveis pela Competência:
GET
https://mde.app.br/api/v1/CTe/resumo?competencia={datacompetencia}{datacompetencia} deve ser no formato:
mmaaaa
200 Exemplo do MIME/JSON retornado:
Onde:
"emissao" - Data de Emissão do CT-e no formato (dd/mm/aaaa).
"hora" - Horário de Emissão do CT-e no formato (hh:mm:ss).
"cnpj" - CNPJ / CPF do emissor do CT-e.
"nome" - Nome do emissor do CT-e.
"tipo" - Tipo do CT-e, onde [0-Entrada | 1-Saída].
"situacao" - Situação do CT-e, onde [0-Autorizado | 1-Denegado | 2-Cancelado | 3-Encerrado ].
"valor" - Valor do CT-e.
"chave" - Chave do CT-e.
"xml" - Tem XML disponível, onde ["S" - Sim | "N" - Não].
Obter os XMLs dos conhecimentos em arquivo ZIP, pela Data de Emissão:
GET
https://mde.app.br/api/v1/CTe/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/CTe/zip?competencia={datacompetencia}{datacompetencia} deve ser no formato:
mmaaaa