Introdução, Autenticação, Versionamento e Erros

Descubra algumas das possibilidades que o Gateway lhe ofereça e como sua API e infraestrutura funciona de forma geral.

Introdução

O eNotas Gateway fornece toda a infraestrutura necessária para o seu sistema se comunicar com qualquer prefeitura integrada com facilidade através de uma API única e uma solução especialista em NFS-e altamente escalável.

Nós criamos nossa API seguindo a técnica REpresentational State Transfer (REST), dessa forma, nossas URLs são amigáveis e previsíveis.

Todas as nossas APIs respondem em JSON ou XML e as chamadas são feitas (na versão mais atual da API) na URL https://api.enotasgw.com.br/v1/

O que posso fazer com a API do Gateway?

Com nossa API você poderá:

Ler (Read)

  • Listar todas as empresas emissoras cadastradas e seus dados
  • Buscar todas as informações das notas fiscais das empresas emissoras
  • Imprimir o PDF de qualquer nota fiscal emitida pelo Gateway
  • Buscar o documento fiscal (XML) de qualquer nota fiscal emitida pelo Gateway

Escrever (Write)

  • Incluir uma empresa emissora (CNPJ Emissor)
  • Emitir notas fiscais para qualquer empresa emissora cadastrada
  • Incluir um certificado digital em uma empresa emissora

Remover (Delete)

  • Cancelar qualquer nota fiscal emitida pelo Gateway

Web hook

Qualquer alteração na situação de qualquer nota fiscal registrada no Gateway irá gerar um POST de notificação nas URLs de callback ativas na sua conta do eNotas Gateway.

A biblioteca PHP liberada no github possui um exemplo de utilização do webhook.​

Autenticação

A autenticação na nossa API é 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). 

Versionamento

Nós liberamos uma nova versão da API toda vez que efetuamos mudanças que não são retrocompatíveis, porém mantemos as antigas versões da API funcionando.

Nossas chamadas de API partem da URL https://api.enotasgw.com.br/v1/ sendo que esse v1 é justamente a versão da API.​

A versão atual é v1​.

Erros (Retornos HTTP)

A nossa API utiliza os próprios Códigos de Status HTTP para indicar sucesso ou falha da chamada.

Em geral os códigos iniciados com 2 indicam sucesso, os iniciados com 4 indicam erro (Ex: Falta de parâmetro obrigatório ou Falha ao autenticar) e iniciados com 5 indicam erro interno nos servidores 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

403

Não autorizado

500

Erro interno do servidor

Ocorreu uma falha no servidor do Gateway

Documentação interativa

Você pode testar toda a API a partir da nossa documentação interativa disponível neste link: http://app.enotasgw.com.br/docs

Você pode visualizar um vídeo de exemplo emitindo uma nota fiscal usando exclusivamente essa documentação (sem programar): http://enotasgw.com.br/exemplo2mins​-floripa

Was this article helpful?

Related Articles

7 Comments

    1. support

      Obrigado Raphael, corrigimos nesse instante! 🙂

  1. Cesar Oliveira

    Link da Documentação Interativa está dando inexistente (404)

  2. João

    Documentação interativa podia ser integrada mas no geral esta muito fácil entender e aplicar.

    1. support

      Obrigado pelo feedback João, estamos avaliando um novo modelo de documentação ainda mais simples e integrado mesmo.

Leave a Reply to Josue × Cancel Reply