eNotas Gateway

eNotasGW Developer Portal

Bem vindo ao eNotas Gateway Developer Portal!

Veja como é simples emitir diversos tipos de documentos fiscais eletrônicos de forma simples e 100% automático com centenas de prefeituras e SEFAZs.

Primeiros Passos      Documentação

Conceitos básicos

Conceitos básicos da plataforma em geral.

Todas as nossas APIs respondem em JSON ou XML.

As chamadas são feitas na URL https://api.enotasgw.com.br/v1/

Utilize /v1/ para NFS-e e /v2/ para NF-e e NFC-e.

Autenticação

A autenticação é feita através da utilização de uma API Key.

É um token único que irá identificar sua conta e pode ser visualizado no menu "API Key".

Há duas maneiras de se autenticar, sendo a primeira, e mais recomendada, utilizando HTTP Basic Auth.

Coloque sua API Key como sendo o username da autenticação básica sem necessidade de nenhum password (senha).

Erros

A API retorna Códigos de Status HTTP para indicar sucesso ou falha da chamada.

Em geral, os códigos iniciados com:

  • 2xx indicam sucesso
  • 4xx indicam erro (Ex: Falta de parâmetro obrigatório ou Falha ao autenticar)
  • 5xx indicam erro interno nos serviços do Gateway

Alguns métodos incluem outros retornos, portanto, consulte sempre o resultado do método utilizado.

200

Sucesso

Método invocado executou com sucesso

401

Falha ao autenticar

Verifique sua API Key

403

Não autorizado

500

Erro interno

Ocorreu alguma instabilidade no Gateway, tente novamente em alguns segundos ou acione nosso suporte.

É importante notar que o código HTTP 200 significa que a requisição ao Gateway foi processada corretamente e não que a nota fiscal tenha sido emitida.

Webhook

Webhooks permitem que sistemas externos recebam notificações de todos os eventos que ocorrem no sistema.

Quando um evento acontece, o sistema envia uma requisição HTTP POST para a URL configurada no webhook com as informações relativas ao evento.

Ao receber a notificação, o sistema pode executar diversas tarefas, dependendo do objetivo da integração.

Os webhooks também são chamados de Callbacks ou Reverse API.

Mais detalhes

Obtenha mais informações sobre isso nesta página