Comunicação via Web API

Comunicação via Web API

Comunicação com o Fiscal.io Monitor via Web API

A integração por meio de WebAPI disponibiliza um serviço de API HTTP que possibilita a comunicação direta com o Fiscal.io Monitor. Esse recurso viabiliza o envio de requisições do tipo GET para consulta de informações e também permite o envio de solicitações no formato REST utilizando JSON como padrão de estrutura de dados, garantindo interoperabilidade e padronização no processo de integração entre sistemas.

O que é uma Web API? É uma interface programática que contém endpoints expostos que habilitação a comunicação por sistemas de terceiros utilizando o padrão JSON.

Requisitos

Como ativar o serviço de Web API

Clique no link localizado no canto inferior esquerdo da tela "Integração: enviar e receber XML" .


Se você já tiver integrações, o Fiscal Monitor abrirá a janela [Gerenciador de Canais de Comunicação] e você deverá clicar em [Adicionar] conforme tela abaixo.


Se for a primeira configuração ou você clicou em [Adicionar], aparecerá a tela abaixo.

Escolha a opção "Receber solicitações via Web Api"  e clique em "Configurar integração".

Na tela abaixo, preencha os seguintes campos:

Nome do canal: Campo para informar o nome do canal.

Objetivo do canal: Receber arquivos XML

Local : Computador que será ativado o serviço de Web API.
Nota: Selecione o nome do computador onde foi instalado Fiscal.io Server conforme manual.

Meio de integração: Integração via Api Web
Frequência : Deve ser escolhida a frequência (tempo) em minutos, que o monitor buscará as informações na pasta.

Destino Http(s): informar o endereço de destino  Porta: informar a porta
Nota: Selecione o nome do computador onde foi instalado Fiscal.io Server conforme manual.

Habilitar rastreabilidade (opcional): Permite analisar o canal de integração e comunicação configurado.
Nota: Marque esta opção somente em ambiente de testes para evitar geração de arquivos de log desnecessário e grandes no servidor.

Clique em "Salvar" para concluir a configuração.



Teste de funcionamento

Após criar a integração, aguarde até 5 minutos, acesse seu navegador de preferência e informe o [nome ou endereço do servidor] + [porta de rede] onde o servidor ativado conforme exemplo abaixo. Lembrando que estas duas informações [servidor] e [porta] são encontradas na tela acima.

Ao acessar a Web API via navegador, deverá aparecer uma tela conforme exemplo abaixo.


Endpoints de comunicação

Obter documentos fiscais e eventos relacionados


Obter Eventos relacionados a documentos fiscais


Obter PDF do documento


Registrar certificado digital

  1. curl --location 'http://localhost:8000/DOC/CERTIFICATE' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.     "GZipCert": "Certificado digital no formato GZip", 
  5.     "Password": "Senha do certificado" 
  6. }'


Cadastrar CPF ou CNPJ

  1. curl --location 'http://localhost:8000/COMPANY' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.        "CNPJ" : "11111111111111",      
  5.        "Nome": "Nome da empresa",      
  6.        "Estado" : "31",                
  7.        "Certificado" : "123123425234", 
  8.        "DisableAutoScan" : "",         
  9.        "Environment" : "1",            
  10.        
  11.        "GetNFeAndEvent" : "X",         
  12.        "NFeDownAuto" : "X",            
  13.        "GetCTeAndEvent" : "X",         
  14.        "GetMDFeAndEvent" : "X",        
  15.        
  16.        "GetNFeOutAndEvent" : "X",      
  17.        "NFeOutDownAuto" : "W",         
  18.        "GetNFCeOutAndEvent" : "X",      
  19.        "NFCeOutDownAuto" : "W",         
  20.        "GetCTeOutAndEvent" : "X",      
  21.        "CTeOutDownAuto" : "W"         
  22. }'


Atribuir etiqueta a documento

  1. curl --location 'http://localhost:8000/DOC/TAG' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.     "Company": "{cnpj ou cpf}",
  5.     "DocKey": "{chave de acesso}",
  6.     "DocTag": "0010"
  7. }'


Registrar evento

  1. curl --location 'http://localhost:8000/EVENT' \
  2. --header 'Content-Type: application/json' \
  3. --data '{
  4.     "Company": "{cnpj ou cpf}",
  5.     "DocKey": "{chave de acesso}",
  6.     "EvtCode": "210210",
  7.     "Reason": ""
  8. }'





          • Related Articles

          • Importação via Socket API

            Receber solicitações via Socket API Para realizar a configuração desta opção, deve-se seguir os passos abaixo. Procedimentos Clique no link localizado no canto inferior esquerdo da tela "Integração: enviar e receber XML". Se o Monitor que você ...

          • Como enviar xmls via API para o Fiscal.io Monitor

            O objetivo deste procedimento é explicar de forma detalhada como usar a API pública da Fiscal.io para envio de XMLs de documentos fiscais e eventos para um ambiente onde esteja instalado o Fiscal.io Monitor. O que é a API publica do Fiscal.io ...

          • Exportação de XMLs para Web APIs

            Enviar XMLs para Web APIs Esta integração permite que o Fiscal.io Monitor assim que é recebido os documentos da SEFAZ faça a entrega destes documentos através de uma API de destino. Para realizar a configuração desta opção, deve-se seguir os passos ...

          • Como enviar registro de escrituração de documentos fiscais via API para o Fiscal.io Monitor

            O objetivo deste procedimento é explicar de forma detalhada como usar a API pública da Fiscal.io para envio dos registros de escriturações dos documentos fiscais em softwares externos para o Fiscal.io Monitor. O que é a API publica do Fiscal.io ...

          • Importação de XML de via servidor de FTP

            Buscar XMLs em Servidores FTP Para realizar a configuração desta opção, deve-se seguir os passos abaixo. Procedimentos Clique no link localizado no canto inferior esquerdo da tela " Integração: enviar e receber XML" . Se o Monitor que você utiliza já ...