Os sistemas podem ser integrados aos processos batch da plataforma CobranSaaS através de uma API de serviços específica, que disponibiliza o acesso às suas funcionalidades. A API é organizada em diferentes conjuntos de funcionalidades (métodos), de acordo com suas finalidades. A documentação detalhada da API de serviços para os processos batch está disponível no link seudominio.cobransaas.com.br/#/docs-api, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
Este guia complementa a documentação da API de serviços e contém orientações sobre quais conjuntos de métodos podem ser utilizados e de que forma podem ser utilizados para atender aos diferentes fluxos de informações que podem ocorrer entre o CobranSaaS e os sistemas integrados aos processos batch da plataforma como, por exemplo, a gestão do processamento global diário, do processamento de importações e de interfaces.
As orientações deste guia também contemplam diversos exemplos de chamadas aos métodos, cada qual com seus respectivos parâmetros e retornos, em arquivos exportados no formato JSON (JavaScript Object Notation), que podem ser utilizados com a ferramenta de mercado Postman (www.postman.com), muito utilizada no desenvolvimento e documentação de APIs, para a realização de testes de chamadas aos métodos da API no ambiente de homologação disponível, sob contratação, no link seudominio.hml.cobransaas.com.br, para a homologação de integrações via API dos sistemas com os processos batch da plataforma CobranSaaS, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS. A importação na ferramenta Postman dos arquivos no formato JSON que estão disponíveis como anexos deste artigo, nos links abaixo, poderá ser realizada através do menu File - Import.
O arquivo Processos Batch.postman_collection.json com os exemplos de chamadas aos métodos referenciados neste guia está configurado para utilizar o recurso de variáveis de ambiente do Postman para fins de autenticação das chamadas aos métodos. São utilizadas a variável HOST, que deverá conter a URL do ambiente a ser acessado, ou seja, seudominio.hml.cobransaas.com.br, a variável USER, que deverá conter o código do aplicativo a ser utilizado para autenticação, e a variável TOKEN_USER, que deverá conter o token do aplicativo que estiver sendo utilizado para o acesso. Estas 3 variáveis de ambiente estão configuradas no arquivo Processos Batch.postman_environment.json. Os conteúdos configurados no arquivo para as variáveis, no entanto, são apenas exemplos; na variável HOST a expressão "seudominio" deverá ser substituída pelo domínio utilizado por sua empresa na plataforma CobranSaaS, na variável USER a expressão "usuario" deverá ser substituída pelo código do aplicativo previamente configurado para ser utilizado no acesso às APIs da plataforma e na variável TOKEN_USER a expressão "token" deverá ser substituída pelo token do aplicativo previamente configurado para ser utilizado no acesso às APIs da plataforma.
Além dos arquivos no formato JSON que estão disponíveis como anexos deste artigo, nos links abaixo também estão disponíveis os arquivos Processos Batch.Importação.zip e Processos Batch.Interface.zip que, por sua vez, contém arquivos de exemplos para processamento de importação, no formato JSON, e para processamento de interface, no formato CSV, respectivamente.
0 Comentários