Os sistemas integrados aos processos batch da plataforma CobranSaaS podem iniciar a importação de interfaces via o método assíncrono Interfaces API - Processar interface. A documentação está em seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces-processar, substituindo "seudominio" pelo domínio da sua empresa.
A lista de registros deve ser enviada em arquivos CSV, com cada registro em uma linha contendo seus atributos separados pelo caractere configurado na interface, conforme exemplos no guia.
O atributo id (Id Externo) é obrigatório para os tipos CLIENTE_ENDERECO, CLIENTE_EMAIL, CLIENTE_TELEFONE e DEVOLUCAO, representando a chave única do sistema de origem. A plataforma usa o id e a operação configurada (INCLUIR, ATUALIZAR, MESCLAR) para determinar se o registro será inserido (INSERT) ou atualizado (UPDATE). Registros com id novo são inseridos se a operação for INCLUIR ou MESCLAR, e registros com id existente são atualizados se a operação for ATUALIZAR ou MESCLAR.
Na chamada do método, o parâmetro id deve conter o id da configuração da interface, obtido conforme Obtendo as Configurações das Interfaces. O parâmetro file deve conter o arquivo CSV para upload, podendo estar opcionalmente compactado em ZIP, recomendado para grandes volumes. Arquivos inválidos retornam erro 400 com a mensagem "Required request part 'file' is not present".
Se a importação iniciar com sucesso, retorna código 200 (OK) e o atributo id com o identificador do processo batch iniciado. O objeto configInterface traz as informações da configuração da interface, dataCriacao indica a data/hora do processo e situacao estará como "INICIANDO".
Por ser método assíncrono, o andamento pode ser consultado conforme Obtendo Informações sobre o Processamento das Interfaces, usando o id retornado.
Exemplos de chamadas e retornos estão na pasta Interfaces API do arquivo Processos Batch.postman_collection.json. Exemplos de arquivos de interface estão no Processos Batch.Interface.zip, anexados em Integrando Sistemas com os Processos Batch.
Comentários
0 comentário
Artigo fechado para comentários.