Serviço API Rest

API Rest é o serviço responsável pela integração entre o Add-On e o Banco onde é possível estabelecer a comunicação com portais para emissão de segunda via de boleto, exibir informações ou até mesmo gerar os boletos de um documento.

1- Pré-Requisitos

O Add-On e serviços instalados devem ser a partir da versão: 3.13.0.5168:

../_images/API_Rest_00.PNG

Dica

Recomendo a utilização do Postman para testar os métodos da API para clientes que ainda não possuem um portal para integração, qualquer dúvida entre em contato com nosso atendimento pelo redmine.

Dica

Faça download dos modelos e importe no Postman para facilitar:.

API IntBank

2- Métodos disponíveis para Integração

Com o serviço em execução é possível realizar algumas integrações do Add-On IntegrationBank através dos métodos a seguir.

2.1- Gerar Token:

Com o serviço API do IntBank instalado e o monitor de serviços abertos, selecione a aba API e clique em Gerar Token para gerarmos a chave de autorização que utilizaremos para obter os retornos dos metodos disponiveis:

../_images/API_Rest_01.PNG

Importante

Na homologação do processo, utilizamos o Postman para realizar os testes dos métodos.

2.2 – Obter Todas as Empresas:

GET [http://localhost:9992/api/empresas], método que retorna todas as empresas cadastradas no Add-On IntegrationBank. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço:

../_images/API_Rest_02.PNG

2.3 – Obter Empresa por Código:

GET [http://localhost:9992/api/empresas/1], método que retorna os dados de uma empresa cadastrada no Add-On IntegrationBank. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço:

../_images/API_Rest_03.PNG

2.4 – Obter os Boletos por Empresa, tipo de nota, número do documento:

GET [http://localhost:9992/api/empresas/1/notafiscal/56/boletos/], método que retorna os dados de todos os boletos de uma empresa, para um tipo de documento e número do documento. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. Esse método exige na URL o código da empresa, O tipo de documento e o DocEntry da nota fiscal e devolve todos os boletos da nota passada na Url:

../_images/API_Rest_04.PNG

3. Métodos de busca do boleto utilizando somente o ID do boleto

3.1 - Obter informações do boleto somente pelo ID:

GET [http://localhost:9992/api/boletos/150183], método que retorna os dados de um boleto utilizando somente o ID. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. Esse método exige na URL o código “boletos” seguido pelo ID do boleto na Url:

../_images/API_Rest_05.PNG

3.2 - Obter PDF do boleto somente pelo ID:

GET [http://localhost:9992/api/boleto/150183.pdf], método que retorna o boleto no formato PDF, Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. Esse método exige na URL o código “boleto” seguido pelo ID do boleto + ”.pdf” na Url:

../_images/API_Rest_06.PNG

4. Métodos para gerar o boleto através de um método POST

4.1 - Gerar boleto(s) de uma nota sem retorno do PDF:

POST [http://localhost:9992/api/empresas/1/notafiscal/1113/boletos], método que faz a geração de um ou mais boletos de uma nota sem retornar o(s) PDF(s) dos boleto(s). Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry e o código “boletos”:

../_images/API_Rest_07.PNG

4.2 - Gerar boleto(s) de uma nota com retorno do PDF:

POST [http://localhost:9992/api/empresas/1/notafiscal/1113/boletos?impresso=s], método que faz a geração de um ou mais boletos de uma nota com o retorno do(s) PDF(s) dos boleto(s). Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry, código “boletos” e impresso=s:

../_images/API_Rest_08.png

4.3 - Gerar boleto da parcela de uma nota sem o retorno do PDF:

POST [http://localhost:9992/api/empresas/1/notafiscal/1113/boletos?parcela=2], método que faz a geração de um boleto referente a uma parcela da nota sem retornar o PDF. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry, código “boletos” e o número da parcela:

../_images/API_Rest_09.png

4.4 - Gerar boleto da parcela de uma nota com retorno do PDF:

POST [http://localhost:9992/api/empresas/1/notafiscal/1113/boletos?parcela=1&impresso=s], método que faz a geração de um boleto referente a uma parcela da nota com o retorno do PDF. Exige que seja passado no Header como a chave de autorização retornada no Token do serviço. É necessário passar os dados do documento como filial, tipo de documento, DocEntry, código “boletos”, número da parcela e impresso=s:

../_images/API_Rest_10.png

Tipos de documento:

Tipos de Documento Parâmetro
Nota Fiscal de Saída notafiscal
Adiantamento adiantamento
Lançamento Contábil Manual lcm