As interfaces correspondem a uma funcionalidade para importação de informações de dados cadastrais de clientes, campos customizados de clientes e de contratos e informações de devoluções de cartas, baseada em layouts configuráveis de arquivos.
Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS podem obter as interfaces configuradas através do método Interfaces API - Listar interfaces, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
Conforme consta na documentação deste método, estão disponíveis parâmetros de entrada que podem ser informados na chamada do método para restringir a lista de interfaces retornadas. O parâmetro nome pode ser utilizado para pesquisar interfaces pelo nome. O parâmetro tipo (IMPORTACAO, EXPORTACAO) pode ser utilizado para retornar apenas interfaces de determinado tipo. O parâmetro situacao (ATIVO, INATIVO) pode ser utilizado para retornar apenas interfaces que estejam ativas ou inativas.
Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS também podem obter uma interface específica, cuja identificação (id) deve ser informada na URL de chamada do método Interfaces API - Buscar interface, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces-id, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
Conforme detalhado na documentação de ambos os métodos citados acima, os mesmos retornam, para cada interface, o identificador da configuração da interface no atributo id, o nome da configuração da interface no atributo nome, a situação da configuração da interface no atributo situacao (ATIVO, INATIVO), o tipo da configuração da interface no atributo tipo (IMPORTACAO, EXPORTACAO), o tipo de operação da configuração da interface no atributo operacao (INCLUIR, ATUALIZAR, MESCLAR, CONSULTAR, EXCLUIR) e a entidade cujas informações são importadas através da interface, no atributo entidade (CLIENTE_CAMPO, CLIENTE_ENDERECO, CLIENTE_EMAIL, CLIENTE_TELEFONE, CONTRATO_CAMPO, DEVOLUCAO, DISCADOR, SMS), sendo que as entidades CLIENTE_CAMPO e CONTRATO_CAMPO referem-se à importação de informações de campos customizados de clientes e de contratos, respectivamente.
Exemplos de chamada e de retorno destes métodos da Interfaces API constam na pasta Interfaces API do arquivo Processos Batch.postman_collection.json, disponível como anexo em Integrando Sistemas com os Processos Batch.
0 Comentários