Os sistemas de assessorias de cobrança podem ser integrados ao 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 assessorias está disponível em assessoria.hml.cobransaas.com.br/#/docs-assessoria-api.
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 de assessorias de cobrança a ele integrados como, por exemplo, a simulação e efetivação de diferentes possibilidades de negociações e o registro do histórico de contatos (tabulações) com os clientes.
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 em um ambiente disponibilizado em assessoria.hml.cobransaas.com.br exclusivamente para a homologação de integrações via API entre os sistemas de assessorias e o 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.
No ambiente de homologação estão configuradas diferentes assessorias de exemplo (Assessoria A, Assessoria B, Assessoria C, Assessoria D) que podem ser utilizadas, cada qual com seu respectivo código de usuário (assessoria.a, assessoria.b, assessoria.c, assessoria.d) que deverá ser utilizado para a autenticação. Cada uma destas assessorias de exemplo contém diferentes lotes de dívidas distribuídas e, portanto, estão disponíveis para testes.
Todos os arquivos no formato JSON com os exemplos de chamadas aos métodos referenciados neste guia estão configurados 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, assessoria.hml.cobransaas.com.br, a variável ASS, que deverá conter o código de usuário a ser utilizado para autenticação (assessoria.a, assessoria.b, assessoria.c, assessoria.d), e a variável TOKEN_ASS, que deverá conter o token (senha) do usuário que estiver sendo utilizado para o acesso. Estas 3 variáveis de ambiente estão configuradas no arquivo assessoria.hml.postman_environment.json. O conteúdo configurado no arquivo para a variável TOKEN_ASS, no entanto, é apenas um exemplo; o token correto para o usuário que for utilizado na autenticação deverá ser solicitado para a equipe do CobranSaaS e deverá ser ajustado pela própria assessoria na variável de ambiente.
As assessorias poderão acessar o ambiente assessoria.hml.cobransaas.com.br somente através de chamadas aos métodos da API de serviços do CobranSaas, uma vez que o acesso à aplicação web deste ambiente não é habilitado para os códigos de usuário (assessoria.a, assessoria.b, assessoria.c, assessoria.d) das assessorias.
0 Comentários