As negociações efetuadas na plataforma CobranSaaS e os seus pagamentos podem ser integradas aos sistemas legados 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 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 legados a serem integrados como, por exemplo, os fluxos para a Integração das Negociações efetuadas na plataforma CobranSaaS e dos seus Pagamentos.
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 dos sistemas legados com a API 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 Negociações.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, a variável TOKEN_USER, que deverá conter o token do aplicativo que estiver sendo utilizado para o acesso através de autenticação tipo BASIC, permitida somente no método para obter o token bearer (POST /oauth/token) que, após ter sido obtido, por sua vez, deverá ser armazenado na variável TOKEN_BEARER, utilizada para a autenticação tipo OAUTH 2, obrigatória em todos os demais métodos da API da plataforma. Estas 4 variáveis de ambiente estão configuradas no arquivo Negociações.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, na variável TOKEN_USER a expressão "token_aplicativo" deverá ser substituída pelo token do aplicativo previamente configurado para ser utilizado no método para obter o token bearer (POST /oauth/token) e na variável TOKEN_BEARER a expressão "token_bearer" deverá ser substituída pelo token bearer que for obtido através do método disponível para esta finalidade (POST /oauth/token).
0 Comentários