Como enviar xmls via API para o Fiscal.io Monitor

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 Monitor?
A API pública é um canal de integração que permite a envio de documentos fiscais de outros ambientes internos ou externos para um ambiente onde esteja instalado o Fiscal.io Monitor seguindo rigidas normas e práticas de autorização de acesso.

Quem deve utilizar esta API?
Empresas ou softwares houses que desejem enviar documentos fiscais para uma instalação do Fiscal.io Monitor.

Ativação da API na assinatura

Acessar a assinatura no site https://app.fiscal.io e cadastrar um endereço de email que servirá de referência para a conexão via API.
Importante: Toda a comunicação será realizada via API e protocolo HTTPS, o e-mail é apenas uma referência para identificação da assinatura e também para definir qual instalação do Fiscal.io Monitor irá receber os documentos fiscais.

Nota: Este passo pode ser feito pelo time de suporte da Fiscal.io ou pelo próprio cliente.


Vinculação da API ao Fiscal.io Monitor ou Fiscal.io Server

Após criar o e mail, vincule o e-mail a máquina onde está instalado o "Fiscal.io Server" que será responsável por receber os documentos, validar e logo após gravar no banco de dados da centralizado dos usuários.

Caso ainda não tenha instalado o Fiscal.io Monitor, deixe para executar este passo em momento posterior.
Este passo pode ser feito pelo time de suporte da Fiscal.io ou pelo próprio cliente.




Obtenção de Token de autenticação

O cliente deverá acessar o site https://app.fiscal.io/Api/Edit e obter o token de autenticação da API conforme tela abaixo.
Nota 04: Este passo deve ser executado exclusivamente pelo cliente utilizando um e-mail que esteja vinculado a licença do Fiscal.io Monitor


Exemplo prático de utilização da API

Após obter o token de autorização, o envio dos documentos para a API deverá ser feito conforme instruções abaixo.
Endereço da API : https://api.fiscal.io/v1/client/queuexml/postdata/email/{email-doc-fiscal}
O trecho {email-doc-fiscal} deve ser trocado pelo e-mail cadastrado no passo 01.

A requisição é feita utilizando o método POST.
Além disso deve ser passado no header da requisição o token de autenticação obtido no passo 03.
O Token deve ser passado pelo header "Authorization", passando o valor basic + token, conforme exemplo abaixo do postman.









O corpo da requisição deverá seguir o modelo abaixo. O formato deverá ser JSON.


Chave: Se trata da chave do documento xml.
OBS: Caso não consiga obter a chave, pode encaminhar esse campo com o valor vazio("").
O campo Chave serve somente para que o cliente consiga identificar, via app.fiscal.io, quais os documentos estão pendentes de integração pelo monitor.
Arquivo: Se trata de uma string(texto) no formato base 64 com o conteúdo do arquivo XML.

Exemplo de utilização da API em cURL.

curl --location -g --request GET 'https://api.fiscal.io/v1/client/queuexml/postdata/email/{email-doc-fiscal}' \
--header 'Authorization: basic 68313c91---------------------------' \
--header 'Content-Type: application/json' \
--data-raw '{
"Chave":"chave-de-acesso-documento",
"Arquivo": "string-arquivo-xml-em-base64"
}

Como visualizar registros enviados para a API

Acessar a assinatura no site https://app.fiscal.io e clicar sobre a opção "Api: Docs" conforme figura abaixo.
Este opção mostrará os 10 primeiros registros armazenados na API e que ainda estão pendentes de integração com o Fiscal.io Monitor.