Documentação

API do Ajuda Nota

Integre as ferramentas fiscais no seu sistema: consulta de CNPJ + Inscrição Estadual, CEP, gerador de CPF/CNPJ, XML de NF-e para Excel e geração de DANFE/NFC-e/NFS-e em PDF. Respostas em JSON (ou o próprio arquivo, nos endpoints de PDF/CSV).

Autenticação

Toda chamada exige uma chave de API no cabeçalho Authorization. Gere a sua em Minha conta › Chaves de API. A chave é exibida uma única vez — guarde em local seguro e nunca a exponha no navegador (use-a só do seu servidor).

Authorization: Bearer an_live_suachave

URL base: https://ajudanota.com.br

Limites e proteção

•Quota mensal por plano (padrão: 5.000 chamadas/mês), somando todas as funcionalidades. Cada chamada consome 1.
•Ritmo de até 60 chamadas por minuto por chave. Acima disso, resposta 429.
•Cada resposta traz X-RateLimit-Limit e X-RateLimit-Remaining.

Precisa de mais volume? Fale conosco para um plano sob medida (inclusive preço por funcionalidade).

Endpoints

GET/api/cnpj/{cnpj}

Consulta de CNPJ + Inscrição Estadual

Dados cadastrais da Receita (razão social, endereço, CNAE, sócios…) já com a Inscrição Estadual da UF da matriz. Use ?uf=XX para consultar a IE em outra UF. Aceita CNPJ numérico ou alfanumérico.

curl "https://ajudanota.com.br/api/cnpj/00000000000191?uf=PR" \
  -H "Authorization: Bearer an_live_suachave"

GET/api/ie/{cnpj}?uf=XX

Inscrição Estadual (isolada)

Só a Inscrição Estadual, quando você já tem o CNPJ e a UF. A UF é obrigatória.

curl "https://ajudanota.com.br/api/ie/00000000000191?uf=PR" \
  -H "Authorization: Bearer an_live_suachave"

GET/api/cep/{cep}

Consulta de CEP

Logradouro, bairro, cidade e UF a partir do CEP (8 dígitos).

curl "https://ajudanota.com.br/api/cep/01310930" \
  -H "Authorization: Bearer an_live_suachave"

GET/api/gerar/{tipo}?quantidade=N

Gerador de CPF/CNPJ (para teste)

Gera CPF ou CNPJ com dígitos verificadores válidos, para testar sistemas. tipo = cpf | cnpj. quantidade de 1 a 50.

curl "https://ajudanota.com.br/api/gerar/cnpj?quantidade=3" \
  -H "Authorization: Bearer an_live_suachave"

POST/api/xml/excel

XML de NF-e/NFC-e → planilha (CSV)

Envie o XML da nota no corpo; recebe um CSV (uma linha por item), pronto para o Excel pt-BR.

curl -X POST "https://ajudanota.com.br/api/xml/excel" \
  -H "Authorization: Bearer an_live_suachave" \
  -H "Content-Type: application/xml" \
  --data-binary @nota.xml

POST/api/danfe

XML → PDF (DANFE / NFC-e / NFS-e)

Envie o XML; recebe o PDF de impressão. Detecta automaticamente NF-e (DANFE A4), NFC-e modelo 65 (cupom 80mm com QR) e NFS-e nacional (DANFSe A4).

curl -X POST "https://ajudanota.com.br/api/danfe" \
  -H "Authorization: Bearer an_live_suachave" \
  -H "Content-Type: application/xml" \
  --data-binary @nota.xml -o danfe.pdf

Formato de erro

Erros retornam JSON com error (código estável) e message (texto). Principais status: 400 (dados inválidos), 401 (chave ausente/inválida), 403 (plano sem API), 422 (XML inválido), 429 (limite de mês ou de ritmo).

{
  "error": "PLANO_SEM_API",
  "message": "Seu plano não inclui acesso via API. Assine o plano API ou Completo."
}

Pronto para integrar?

Crie sua conta, escolha um plano com API e gere sua chave.

Ver planos Gerar chave