• 2ª via de Boleto
  • Suporte
    • CENTRAL DE AJUDA
    • ABRIR CHAMADO
    • SUPORTE VIA CHAT
    • Atendimento 100% online e humano pelos nossos Weblovers 😊️
    • E-mail: 24 horas por dia
      Chat: Segunda a Sexta-feira das 10h às 18h, exceto feriados
  • Vendas
    • INICIAR CONVERSA
    • ENVIAR E-MAIL
    • Atendimento 100% online e humano pelos nossos Weblovers 😊️
    • E-mail: 24 horas por dia
      Chat: Segunda a Sexta-feira das 10h às 18h, exceto feriados
  • PAINEL DO CLIENTE
Suporte Técnico WebmaniaBR®

Oi, estamos aqui para te ajudar 😄

A WebmaniaBR® conta com um time de Weblovers completo, com especialistas no emissor de Nota Fiscal, contabilidade, código de programação, módulos de loja virtual e principalmente no encantamento das nossas soluções.


Está com dúvidas?
Confira nossa Central de Ajuda

Ainda com dúvidas? Estamos aqui! 😊️

  • Envie um E-mail com todos os detalhes (abrir ticket)
  • Ou acesse o Painel WebmaniaBR® e converse via Chat (iniciar chat)

Horário de atendimento:
E-mail 24 horas por dia. Chat de Segunda a Sexta-feira das 10h às 18h, exceto feriados.

  • Tecnologias
    • PRODUTOS
      Simplifique o dia a dia da sua empresa com as tecnologias da WebmaniaBR®
      Emissor de Nota Fiscal Consulta de Nota Fiscal Consulta de CEP e IBGE Certificado Digital A1 (5% OFF)
    • DOCUMENTAÇÃO
      Comece a integrar com as tecnologias da WebmaniaBR®
      API Nota Fiscal API Consulta de Nota Fiscal API CEP e IBGE API Gerencial B2B
  • Emissor de Nota Fiscal
  • Tecnologias
    • Emissor de Nota Fiscal
    • Consulta de Nota Fiscal Consulta de CEP e IBGE Certificado Digital A1 (5% OFF) API de Nota Fiscal API de Consulta de Nota Fiscal API de CEP e IBGE API Gerencial B2B
  • API
  • Blog
  • Clientes
  • Contato
  • FALE CONOSCO
  • CENTRAL DE AJUDA
  • PAINEL DO CLIENTE
  • 0
      Ver Carrinho Finalizar Compra
  • REST API Consulta
  • Guia Rápido
  • Autenticação
  • Consultar Nota Fiscal
  • Download XML
    • Emissor WebmaniaBR®
    • Outros emissores
  • Consultar Requisições
  • Infraestrutura
  • Limite de requisições
⚡ Acompanhe em tempo real as atualizações da API no Twitter
Versão: 1.0.0

REST API de Consulta de Nota Fiscal

Utilize a REST API da WebmaniaBR® de alta disponibilidade, segura e atualizada em tempo real para consultar as chaves das Notas Fiscais diretamente na Sefaz de cada estado.

Utilize todos os recursos da API WebmaniaBR® na sua aplicação
A partir de R$34,90/mês incluso 100 consultas por mês
Integração REST API
Compatível com todas as linguagens de programação, através da comunicação via JSON. Garantia de baixa latência com mais de 200 pontos de presença na rede Amazon Web Services.
Disponibilidade e Segurança
Alta disponibilidade, escalonável e servidores redundantes no mais alto nível de segurança PCI DSS na líder global de cloud computing Amazon Web Services.
Consulta Nacional
Cobertura de 100% do território nacional nas consultas de Notas Fiscais nos modelos NF-e e NFC-e. Saiba mais
Auditoria
Faça o download do XML das Notas Fiscais emitidas e obtenha o status em tempo real da Nota Fiscal para tomada de decisão.

Guia Rápido

Todas as solicitações na API devem ser realizadas em ambiente criptografado HTTPS através da URL https://webmaniabr.com/api/. O prefixo /1/ indica que atualmente nós estamos utilizando a versão 1.0 da API.

As consultas na Sefaz devem ser realizadas com o Certificado Digital A1 do CNPJ ou CPF configurado no painel WebmaniaBR®.
URL HTTP Verb Função
/1/nfe/consulta POST Consulta modelo NF-e e NFC-e
/1/nfe/consulta/requests/ POST Consultar Requisições e Limites

Todas as respostas são no formato objeto JSON.

Autenticação

Para as solicitações o corpo da requisição [body] deve ser enviado no formato JSON com o header Content-Type definido para application/json.

A autenticação é realizada através do cabeçalho HTTP (HTTP headers). É necessário o envio do X-Consumer-Key, X-Consumer-Secret e X-Token.

Mantenha as credenciais de acesso em segurança. Nunca publique as credenciais de acesso no código fonte do site, aplicativo ou software onde o usuário possa ter fácil acesso.

Para aplicativos mobile iOS e Android recomendamos que o processo de consulta seja realizado no servidor (back-end). No código fonte do aplicativo deve possuir somente a solicitação de consulta, enquanto o processo deve ser realizado em seu servidor.

Consultar Nota Fiscal

Para realizar a consulta de Nota Fiscal, envie a requisição no método POST para a URL /1/nfe/consulta/ com as credenciais da sua aplicação e contendo no corpo o parâmetro chave. Segue abaixo exemplo:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Token: SEU_TOKEN" \
-H "Content-Type: application/json" \
-d '{
  "chave":"00000000000000000000000000000000000000000000"
}' \
https://webmaniabr.com/api/1/nfe/consulta/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os seguintes campos:

Parâmetro Tipo Descrição
chave número Chave de identificação da Nota Fiscal no Sefaz
status string Status da Nota Fiscal
aprovado
cancelado
processamento
invalido
motivo número Motivo retornado pela Sefaz
emitente número CNPJ do emitente
uf número Estado do emitente
ano número Ano de emissão
mes número Mês de emissão
modelo string Modelo da Nota Fiscal
nfe
nfce
serie número Série da Nota Fiscal
nfe número Número da Nota Fiscal
emissao número Tipo de emissão
1 - Normal
6 - Contingência SVC-AN
7 - Contingência SVC-RS
9 - Contingência off-line da NFC-e
docs array Download do XML da Nota Fiscal
Saiba mais
log array Log de retorno do Sefaz

Segue exemplo no formato JSON:

{
  "chave": "00000000000000000000000000000000000000000000",
  "status": "aprovado", // aprovado, cancelado, processamento, invalido
  "motivo": "Autorizado o uso da NF-e", // Motivo da Sefaz
  "emitente": "00000000000000", // CNPJ do emitente
  "uf": "SP", // UF do emitente
  "ano": "00", // Ano da emissão
  "mes": "00", // Mês da emissão
  "modelo": "nfe", // Modelo
  "serie": "000", // Série
  "nfe": "000000000", // Número
  "emissao": "1", // Tipo de emissão
  "docs": "[{...}]", // Download XML
  "log": "{...}" // Log de retorno da SEFAZ
}

Quando uma requisição ocorre falha o corpo da resposta [body] continua no formato JSON, mas sempre contém o campo error e status. Por exemplo, caso a chave seja inválida será retornado a seguinte mensagem:

{
  "chave": "00000000000000000000000000000000000000000000",
  "error": "Chave de acesso inválida. Não é possível consultar a Sefaz.",
  "status": "invalido"
}

Download XML da Nota Fiscal

Através da Consulta da Nota Fiscal é possível realizar o download do XML de Notas Fiscais emitidas na WebmaniaBR® e em outros emissores.

Consulte todas as condições em que o XML é disponibilizado. De acordo com as diretrizes da Sefaz alguns pré-requisitos são necessários para download do XML, nós simplificamos todas as condições quando emitida na WebmaniaBR® e em outros emissores.

O documento XML quando disponível se encontra no parâmetro docs da requisição, com os parâmetros status, modelo, versao e xml dentro da array. Segue abaixo:

Parâmetro Tipo Descrição
modelo string Modelo do XML
xml_resumo
xml_completo
evento_resumo
evento_completo
versao string Versão do XML retornado
Exemplo:
4.00|WEBMANIABR
4.00|SEFAZ
xml string Arquivo XML
XML retornado pela WebmaniaBR® ou Sefaz

Segue exemplo no formato JSON:

{
  ...
  "docs": [
    {
      "modelo": "xml_completo", // Modelo do XML
      "versao": "4.00|[WEBMANIABR|SEFAZ]", // Versão do XML
      "xml": "<\xml>...<\xml>" // Arquivo XML
    }
  ],
}

Download XML
Emissor WebmaniaBR®

O download do XML das Notas Fiscais emitidas no emissor da WebmaniaBR® abrange os modelos NF-e e NFC-e, onde sempre é retornado o XML completo na consulta.

A consulta pode ser realizada pelo emitente, destinatário, transportador e terceiros. Por exemplo, a matriz pode ter o controle de todas as Notas Fiscais emitidas pelas filiais que também emitem na WebmaniaBR®, realizando a auditoria contábil necessária.

Tipo Descrição
Emitente ✅ Disponibilizado para emitente o XML completo da Nota Fiscal.
xml_completo
Destinatário ✅ Disponibilizado para destinatário o XML completo da Nota Fiscal.
xml_completo
Transportador ✅ Disponibilizado para transportador o XML completo da Nota Fiscal.
xml_completo
Terceiros ✅ Disponibilizado para terceiros o XML completo da Nota Fiscal.
xml_completo

Segue exemplo no formato JSON:

{
  ...
  "docs": [
    {
      "modelo": "xml_completo", // Modelo do XML
      "versao": "4.00|WEBMANIABR", // Versão do XML da WebmaniaBR®
      "xml": "<\xml>...<\xml>" // Arquivo XML
    }
  ],
}


Download XML
Outros emissores

As condições para download do XML de outros emissores está disponível somente no modelo NF-e, onde possui condições de acordo com o CNPJ/CPF que está realizando a requisição seja emitente, destinatário, transportador ou terceiro.

Veja todas as condições de acordo com o tipo de requisição.

Tipo Descrição
Emitente ❌ Não é relizado o download do XML caso a solicitação seja realizada pelo próprio emitente. A legislação determina que o emitente precisa armazenar por 5 anos o XML da Nota Fiscal emitida.
Destinatário ✅ Disponibilizado para destinatário a versão resumo e completa do XML da Nota Fiscal. Somente é disponibilizado a versão completa, caso o destinatário manifestar como "Ciência da Operação", "Operação não Realizada" ou "Confirmação de Operação".
xml_resumo
xml_completo
Transportador ✅ Disponibilizado para transportador o XML completo da Nota Fiscal, quando identificado na Nota Fiscal no grupo X03 do XML.
xml_completo
Terceiros ✅ Disponibilizado para terceiros o XML completo da Nota Fiscal, quando informado o CNPJ/CPF na tag autXML da Nota Fiscal.
xml_completo

Segue exemplo no formato JSON:

{
  ...
  "docs": [
    {
      "modelo": "xml_completo", // Modelo do XML
      "versao": "4.00|SEFAZ", // Versão do XML da Sefaz
      "xml": "<\xml>...<\xml>" // Arquivo XML
    }
  ],
}

Consultar Requisições e Limites

Para consultar o uso das requisções e os limites da API, envie a requisição no método POST para a URL /1/nfe/consulta/requests/ com as credenciais da sua aplicação. Segue abaixo exemplo:

curl -X POST \
-H "X-Consumer-Key: SEU_CONSUMER_KEY" \
-H "X-Consumer-Secret: SEU_CONSUMER_SECRET" \
-H "X-Token: SEU_TOKEN" \
-H "Content-Type: application/json" \
https://webmaniabr.com/api/1/nfe/consulta/requests/

A resposta do corpo da mensagem será no formato objeto JSON, contendo os campos total, limit, expires_in e plan:

{
  "total": 0, // Requisições
  "limit": 100, // Limite de requisições
  "expires_in": "2021-02-28 23:59:59", // Data de expiração
  "plan": "paid" // Plano atual
}

Infraestrutura

O servidores da WebmaniaBR estão localizados na Amazon AWS, líder global em cloud computing, na região us-east-1 (Leste dos EUA) com ponto de presença em sa-east-1 (São Paulo). Manter a sua estrutura perto de algumas das duas localidades, garante um menor tempo de resposta nas requisições na API.

Utilizamos uma infraestrutura na Amazon AWS anycast de alta disponibilidade, o que significa que ao se comunicar com API da WebmaniaBR a requisição será redirecionada para o servidor mais próximo da sua localidade. As requisições dos endpoints são gerenciados através de IP's estáticos, caso necessite autorize no firewall a comunicação com os seguintes IP's:

  • 13.248.145.90
  • 76.223.17.240

Limite de requisições

A WebmaniaBR® aplica um limite de solicitações por segundo e total requisições por mês de acordo com o plano escolhido, calculado com a soma das solicitações do lado do cliente e do lado do servidor. Se o aplicativo exceder o limite inicial, apresentará falhas.

  • Localização do servidor: O firewall bloqueia por padrão o IP de servidores em regiões com alto índice de ataques, como na Europa e na Ásia oriental. Caso a sua comunicação via GET no endpoint https://webmaniabr.com/api/ retorne 403 Erro Forbidden entre em contato para liberarmos o IP do seu servidor.
  • Credenciais de acesso: Os endpoints exigem as credenciais de acesso válida e correta na URI da requisição, o envio incorreto é atribuído como uso indevido da API.
PRODUTOS
  • Emissor de Nota Fiscal
  • Consulta de Nota Fiscal
  • Consulta de CEP e IBGE
  • Nota Fiscal WooCommerce
  • Certificado Digital A1
DOCUMENTAÇÃO
  • API Nota Fiscal
  • API Consulta de
    Nota Fiscal
  • API CEP e IBGE
  • API Gerencial B2B
WebmaniaBR®
  • Blog
  • Clientes
  • Sobre nós
  • Faça parte da equipe
  • Política de Cookies
  • Política de Privacidade
  • Contratos
Acesso Rápido
  • Fale conosco
  • Painel do Cliente
  • Central de Ajuda
  • 2ª via de Boleto
  • Status dos Serviços
FORMAS DE PAGAMENTO
Cartões de crédito Visa, Mastercard, Diners Club, American Express, Hipercard e Elo Boleto Bancário

como podemos
te ajudar?

Fale conosco
Site seguro com criptografia (SSL).
Blindado contra roubo de informações e clonagem de cartão.

Copyright © 2009-2021 WebmaniaBR®.

WebmaniaBR® é uma marca registrada e de uso exclusivo da WebmaniaBR Serviços Empresariais LTDA - CNPJ: 11.290.027/0001-82 e WebmaniaBR Desenvolvimento de Software LTDA - CNPJ: 30.902.296/0001-05 sediado na Av. Anita Garibaldi, 850, Sala 809 Royal - Curitiba, PR - CEP 80540-180
Nós usamos cookies para melhorar sua experiência em nossos serviços, personalizar publicidade e recomendar conteúdo de seu interesse. Ao navegar pelo site, você concorda com tal monitoramento. Em caso de dúvidas, acesse nossa Política de Privacidade e Política de Cookies.
Entendi e aceito