Desenvolvedores

última atualização: sexta-feira, 25 de maio de 2018

DANFE.br.com API

DANFE.br.com é um sistema para controle de notas fiscais eletrônicas, e o principal objetivo dessa API é facilitar a vida dos desenvolvedores. Com a nossa API você consegue os dados de uma NFe (XML ou PDF), através da chave de acesso ou xml em poucos minutos.

Achou algum Bug?

Se você achar alguma falha ou precisar de ajuda para conseguir fazer a API funcionar entre em contato com o nosso suporte, danfe.br.com/suporte.

Acesso da API

1º Passo

Você deve liberar que a API tenha acesso a sua conta, por padrão todas as contas vem bloqueadas o acesso via API. Para liberar o acesso da API, acesse a sua conta e vá para o menu (configurações -> sistema), basta marca a opção "Permitir o uso da API em minha conta?" e salvar.

configurações > sistema:

http://danfe.br.com/app/sistema

2º Passo

Pegando sua API Key, a chave da sua API garante que as NFe geradas via API caia diretamente na sua conta, assim você pode gerenciar a qualquer momento. Para ter acesso a sua API Key, acesse sua conta e vá para o menu (configurações -> api key).

configurações > api key:

http://danfe.br.com/app/apikey

Gerando DANFE

Aviso API

Lembre-se se o portal da nota fiscal eletrônica (nfe.fazenda.gov.br) atualizar os seus dados, possa ser que surja uma nova versão da API. Fique de olho nessa página e no blog que sempre terá novidades.

API 1.0 [XML]

Endereço da API
URL Formatos
http://danfe.br.com/api/nfe/danfe.json .json, .jsonp, .xml, .csv, .php e .html
modelo de uso do "danfe.json":

Método HTTP GET: apikey

Método HTTP POST: string com xml

http://danfe.br.com/api/nfe/danfe.json?apikey=API_KEY

Erros da API (status = false)
Erro Descrição
ERRO_XML_INVALIDO XML inválido.
Sucesso da API (status = true)
Variável Descrição
xml Endereço com XML da NFe.
pdf Endereço com PDF da NFe.
Exemplos de Códigos

API 1.0 [CHAVE] (desabilitado)

Endereço da API
URL Formatos
http://danfe.br.com/api/nfe/danfe.json .json, .jsonp, .xml, .csv, .php e .html
modelo de uso do "danfe.json":

Método HTTP GET: apikey e chave

http://danfe.br.com/api/nfe/danfe.json?apikey=API_KEY&chave=CHAVE_DE_ACESSO

Erros da API (status = false)
Erro Descrição
ERRO_APIKEY_INVALIDA A API Key é inválida, ela deve ter 32 caracteres, somente letras e números.
ERRO_APIKEY_INEXISTENTE A API Key não existe, verifique se você mudou a chave da sua API.
ERRO_API_ACESSO Conta sem liberar o acesso da API. Verifique no menu (configurações > sistema).
ERRO_CHAVE_INVALIDA Verifique a chave de acesso da NFe.
ERRO_RECEITA Variável adicional "mensagem" com erro fornecido pelo portal da NFe.
ERRO_RECEITA_OBTER_DADOS Portal da NFe temporariamente offline.
Sucesso da API (status = true)
Variável Descrição
xml Endereço com XML da NFe (sem assinatura).
pdf Endereço com PDF da NFe.
urlcertificado Endereço com XML da NFe (com assinatura), requer certificado digital.
Exemplos de Códigos

API 1.0 [CAPTCHA]

Endereço da API
URL Formatos
http://danfe.br.com/api/nfe/captcha.json .json, .jsonp, .xml, .csv, .php e .html
http://danfe.br.com/api/nfe/imagem.json .json, .jsonp, .xml, .csv, .php e .html
http://danfe.br.com/api/nfe/nfe_captcha.json .json, .jsonp, .xml, .csv, .php e .html
modelo de uso do "captcha.json":

Método HTTP GET: apikey

http://danfe.br.com/api/nfe/captcha.json?apikey=API_KEY

Erros da API (status = false)
Erro Descrição
ERRO_APIKEY_INVALIDA A API Key é inválida, ela deve ter 32 caracteres, somente letras e números.
ERRO_APIKEY_INEXISTENTE A API Key não existe, verifique se você mudou a chave da sua API.
ERRO_API_ACESSO Conta sem liberar o acesso da API. Verifique no menu (configurações > sistema).
Sucesso da API (status = true)
Variável Descrição
key Key serve para recuperar a imagem do captcha e acessar a NFe.
modelo de uso do "imagem.json":

Método HTTP GET: apikey e key

http://danfe.br.com/api/nfe/imagem.json?apikey=API_KEY&key=KEY

Erros da API (status = false)
Erro Descrição
ERRO_APIKEY_INVALIDA A API Key é inválida, ela deve ter 32 caracteres, somente letras e números.
ERRO_APIKEY_INEXISTENTE A API Key não existe, verifique se você mudou a chave da sua API.
ERRO_API_ACESSO Conta sem liberar o acesso da API. Verifique no menu (configurações > sistema).
ERRO_KEY_INVALIDA A Key é inválida, ela deve ter 32 caracteres, somente letras e números.
ERRO_KEY_INEXISTENTE A Key não existe, verifique se vou gerou a Key.
Sucesso da API (status = true)
Variável Descrição
captcha Endereço de acesso ao captcha para ser digitado.
modelo de uso do "nfe_captcha.json":

Método HTTP GET: apikey, key, chave e captcha

http://danfe.br.com/api/nfe/nfe_captcha.json?apikey=API_KEY&key=KEY&chave=CHAVE_DE_ACESSO&captcha=CAPTCHA

Erros da API (status = false)
Erro Descrição
ERRO_APIKEY_INVALIDA A API Key é inválida, ela deve ter 32 caracteres, somente letras e números.
ERRO_APIKEY_INEXISTENTE A API Key não existe, verifique se você mudou a chave da sua API.
ERRO_API_ACESSO Conta sem liberar o acesso da API. Verifique no menu (configurações > sistema).
ERRO_KEY_INVALIDA A Key é inválida, ela deve ter 32 caracteres, somente letras e números.
ERRO_KEY_INEXISTENTE A Key não existe, verifique se vou gerou a Key.
ERRO_CHAVE_INVALIDA Verifique a chave de acesso da NFe.
ERRO_CAPTCHA_INVALIDO O captcha digitado não confere com a imagem.
ERRO_RECEITA Variável adicional "mensagem" com erro fornecido pelo portal da NFe.
ERRO_RECEITA_OBTER_DADOS Portal da NFe temporariamente offline.
Sucesso da API (status = true)
Variável Descrição
xml Endereço com XML da NFe (sem assinatura).
pdf Endereço com PDF da NFe.
urlcertificado Endereço com XML da NFe (com assinatura), requer certificado digital.
Exemplos de Códigos