As interfaces permitem importar dados cadastrais de clientes, campos customizados de clientes e contratos, e devoluções de cartas, usando layouts configuráveis.
Sistemas integrados à plataforma CobranSaaS podem listar interfaces via o método Interfaces API - Listar interfaces. A documentação está em seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces, substituindo "seudominio" pelo domínio da sua empresa.
É possível filtrar a lista por parâmetros: nome (pesquisa por nome), tipo (IMPORTACAO, EXPORTACAO) e situacao (ATIVO, INATIVO).
Também é possível obter uma interface específica pelo id usando o método Interfaces API - Buscar interface, com documentação em seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces-id.
Os métodos retornam, para cada interface, atributos como: id, nome, situacao (ATIVO/INATIVO), tipo (IMPORTACAO/EXPORTACAO), operacao (INCLUIR, ATUALIZAR, MESCLAR, CONSULTAR, EXCLUIR) e entidade (CLIENTE_CAMPO, CLIENTE_ENDERECO, CLIENTE_EMAIL, CLIENTE_TELEFONE, CONTRATO_CAMPO, DEVOLUCAO, DISCADOR, SMS). CLIENTE_CAMPO e CONTRATO_CAMPO referem-se a campos customizados de clientes e contratos.
Exemplos de chamadas e retornos estão na pasta Interfaces API do arquivo Processos Batch.postman_collection.json, disponível em Integrando Sistemas com os Processos Batch.
Comentários
0 comentário
Artigo fechado para comentários.