Back to top

Anron API Cloud

API que será utilizada por todos os sistemas da Esy Software. Vai dispensar a instalação do sistema de nota fiscal eletrônica e permitir que os sistemas sejam atualizados automaticamente. Com essa API não será necessário ativar licenças de uso, já que a utilização da API será liberada para empresas cadastradas e que tenham situação ativa.

Empresas

Recurso Empresas

Listar todas as Empresas
GET/empresas

Listar todas as empresas com suas respectivas Jobs.

Example URI

GET http://127.0.0.1:3000/empresas
Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload : "Erro ao tentar Buscar Empresas"

Recurso Empresas

Consultar Empresas
GET/empresas/query{?cnpj}{?uf}{?versao}{?servico}

Consulta as Empresas com base nos parâmetros de consulta.

Example URI

GET http://127.0.0.1:3000/empresas/query?cnpj='22044767000155'?uf=26?versao='3.10'?servico='nfe'
URI Parameters
HideShow
cnpj
string (optional) Example: '22044767000155'
uf
number (optional) Example: 26
servico
string (optional) Example: 'nfe'
versao
string (optional) Example: '3.10'
Request
HideShow
Headers
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload : "Erro ao tentar Buscar Empresa"

Criar Empresa
POST/empresas/query{?cnpj}{?uf}{?versao}{?servico}

Para criar uma nova empresa com o CNPJ, Ativa e Tipo de Certificado. Inicialmente a empresa não terá nenhuma Job associada à Empresa.

  • cnpj (string) - O CNPJ da empresa

  • uf (Number) - Código do Estado da Empresa

  • ativa (Number) - 1: Ativa, 0: Inativa

  • certificadoTipo (string) - O tipo do certificado (A1 ou A3) da Empresa.

Example URI

POST http://127.0.0.1:3000/empresas/query?cnpj='22044767000155'?uf=26?versao='3.10'?servico='nfe'
URI Parameters
HideShow
cnpj
string (optional) Example: '22044767000155'
uf
number (optional) Example: 26
servico
string (optional) Example: 'nfe'
versao
string (optional) Example: '3.10'
Request
HideShow
Headers
Content-Type: application/json
Body
{
    "cnpj" : "22044767000155",
    "uf" : 26
    "ativa" : 1,
    "certificadoTipo" : "A3"
}
Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload : "Erro ao tentar Salvar Empresa"

Jobs Empresa

Recurso Jobs de Empresa

Listar todas as Jobs
GET/empresas/{cnpj}/jobs

Lista todas as Jobs da empresa com CNPJ e que ainda não foram concluídas.

Example URI

GET http://127.0.0.1:3000/empresas/'22044767000155'/jobs
URI Parameters
HideShow
cnpj
string (required) Example: '22044767000155'

CNPJ da empresa.

Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload : "Erro ao tentar Buscar as Jobs"

Recurso Jobs de Empresa

Concluir Job
PUT/empresas/{cnpj}/jobs/{id_job}

Concluir a Job que possui o ID passado na URL.

Example URI

PUT http://127.0.0.1:3000/empresas/'22044767000155'/jobs/'5ad0a4907a9b3c2050de3d7d'
URI Parameters
HideShow
cnpj
string (required) Example: '22044767000155'

CNPJ da empresa.

id_job
string (required) Example: '5ad0a4907a9b3c2050de3d7d'

ID da job

Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
payload : "Empresa não encontrada"
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload: "Erro ao tentar Atualizar Job"

Obter Job
GET/empresas/{cnpj}/jobs/{id_job}

Obtem a Job que possui o ID passado como parâmetro e que esteja definida para a empresa com CNPJ informado no parâmetro.

Example URI

GET http://127.0.0.1:3000/empresas/'22044767000155'/jobs/'5ad0a4907a9b3c2050de3d7d'
URI Parameters
HideShow
cnpj
string (required) Example: '22044767000155'

CNPJ da empresa.

id_job
string (required) Example: '5ad0a4907a9b3c2050de3d7d'

ID da job

Response  200
HideShow
Headers
Content-Type: application/json
Response  400
HideShow
Headers
Content-Type: application/json
Body
payload : "Empresa não encontrada"
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload : "Erro ao tentar Buscar a Job"

Fiscal

Recurso Enviar Nota

Recurso destinado a realizar todas as ações relacionadas à comunicação com a SEFAZ. Para alterar a ação utilizada basta alterar o parâmetro ação, informando um dos nomes de serviços disponibilizados pela SEFAZ.

Enviar Nota
POST/fiscal/{cnpj}/{acao}{?servico}{?versao}{?uf}{?ambiente}

Recebe uma nota em formato JSON. Caso a empresa possua certificado A1, o envio da nota ficará de responsabilidade da API. Caso a empresa possua certificado A3, a API deve criar uma Job para a empresa, que posteriormente será notificada para solicitar os Jobs pendentes.

Example URI

POST http://127.0.0.1:3000/fiscal/'22044767000155'/'NfeAutorizacao'?servico='nfe'?versao='3.10'?uf=26?ambiente='homologacao'
URI Parameters
HideShow
cnpj
string (required) Example: '22044767000155'

CNPJ da empresa.

servico
string (required) Example: 'nfe'

Serviço utilizado para enviar a nota, podendo ser nfe ou nfce.

versao
string (required) Example: '3.10'

Versão do serviço da SEFAZ que deve ser utilizado, pode ser 4.00 ou 3.10.

uf
number (required) Example: 26

Código do estado onde o serviço da SEFAZ será solicitado.

ambiente
string (required) Example: 'homologacao'

Ambiente da SEFAZ que será utilizado para executar a ação, podendo ser producao ou homologacao.

acao
string (required) Example: 'NfeAutorizacao'

Nome da ação realizada no servidor da SEFAZ.

Request
HideShow
Headers
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Response  412
HideShow
Headers
Content-Type: application/json
Body
payload : "Web Service não encontrado"
Response  404
HideShow
Headers
Content-Type: application/json
Body
payload : "CNPJ não encontrado"
Response  403
HideShow
Headers
Content-Type: application/json
Body
payload : "Empresa inativa"
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload: "Erro ao tentar Adicionar uma nova Job"

Consultar Status SEFAZ
GET/fiscal/{cnpj}/{acao}{?servico}{?versao}{?uf}{?ambiente}

Consulta o status do serviço da SEFAZ. Caso a empresa utilize certificado A3, uma nova job é criada para a empresa e a mesma será notificada sobre a nova Job posteriormente.

Example URI

GET http://127.0.0.1:3000/fiscal/'22044767000155'/'NfeStatusServico'?servico='nfe'?versao='3.10'?uf=26?ambiente='homologacao'
URI Parameters
HideShow
cnpj
string (required) Example: '22044767000155'

CNPJ da empresa.

servico
string (required) Example: 'nfe'

Serviço utilizado para enviar a nota, podendo ser nfe ou nfce.

versao
string (required) Example: '3.10'

Versão do serviço da SEFAZ que deve ser utilizado, pode ser 4.00 ou 3.10.

uf
number (required) Example: 26

Código do estado onde o serviço da SEFAZ será solicitado.

ambiente
string (required) Example: 'homologacao'

Ambiente da SEFAZ que será utilizado para executar a ação, podendo ser producao ou homologacao.

acao
string (required) Example: 'NfeStatusServico'

Ação utilizada para consultar o status do serviço na SEFAZ.

Request
HideShow
Headers
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Response  412
HideShow
Headers
Content-Type: application/json
Body
payload : "Web Service não encontrado"
Response  404
HideShow
Headers
Content-Type: application/json
Body
payload : "CNPJ não encontrado"
Response  403
HideShow
Headers
Content-Type: application/json
Body
payload : "Empresa inativa"
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload: "Erro ao tentar Adicionar uma nova Job"

WebServices

Recurso WebServices

Adicionar WebServices
POST/webservices

Adiciona uma lista previamente configurada com os web services do estado de Pernambuco para os serviços de NF-e e NFC-e.

Example URI

POST http://127.0.0.1:3000/webservices
Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
payload : "Erro ao tentar Salvar Web Servers"

Listar todos os Web Services
GET/webservices

Lista todos os Web Services existentes.

Example URI

GET http://127.0.0.1:3000/webservices
Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
{payload : "Erro ao tentar Listar Web Services"}

Recurso WebServices

Consultar Web Service
GET/webservices/query{?servico}{?versao}{?uf}{?ambiente}

Consulta os Web Services existentes com base nos parâmetros passados na query da url.

Example URI

GET http://127.0.0.1:3000/webservices/query?servico='nfe'?versao='3.10'?uf=26?ambiente='homologacao'
URI Parameters
HideShow
servico
string (required) Example: 'nfe'

Serviço utilizado para enviar a nota, podendo ser nfe ou nfce.

versao
string (required) Example: '3.10'

Versão do serviço da SEFAZ que deve ser utilizado, pode ser 4.00 ou 3.10.

uf
number (required) Example: 26

Código do estado onde o serviço da SEFAZ será solicitado.

ambiente
string (required) Example: 'homologacao'

Ambiente da SEFAZ que será utilizado para executar a ação, podendo ser producao ou homologacao.

Response  200
HideShow
Headers
Content-Type: application/json
Response  500
HideShow
Headers
Content-Type: application/json
Body
{payload : "Erro ao tentar Listar os WebServices"}

Generated by aglio on 23 Apr 2018