Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS podem iniciar a importação de interfaces dos diferentes tipos de entidade disponíveis através do método assíncrono Interfaces API - Processar interface, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/interfaces/api-interfaces-processar, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
A lista de registros a serem importados deverá obrigatoriamente ser informada em arquivos no formato CSV (Comma Separated Values), sendo que cada registro deverá ser informado, individualmente, em uma única linha do arquivo contendo todos os seus atributos, separados pelo caractere separador que estiver configurado na interface, conforme pode ser observado nos arquivos CSV de exemplo de interface disponibilizados neste guia.
No arquivo de interface a ser importado, o atributo id (Id Externo) deverá estar presente nos registros das interfaces dos tipos de entidade CLIENTE_ENDERECO, CLIENTE_EMAIL, CLIENTE_TELEFONE e DEVOLUCAO e sempre deverá ser informado com a chave única de identificação do registro no sistema de origem da informação. É através do conteúdo deste atributo id e da operação (INCLUIR, ATUALIZAR, MESCLAR) que estiver configurada na interface que a plataforma determina, durante o processamento da importação, quais registros deverão ser inseridos (INSERT) e quais registros deverão ser atualizados (UPDATE) na base de dados da plataforma. Registros que estiverem sendo importados com ids que ainda não existem serão inseridos na base de dados da plataforma se a interface estiver configurada com a operação INCLUIR ou MESCLAR e registros que estiverem sendo importados com ids já existentes serão atualizados na base de dados da plataforma se a interface estiver configurada com a operação ATUALIZAR ou MESCLAR.
Na chamada ao método, o parâmetro de entrada id deverá ser informado, obrigatoriamente, com o id da configuração da interface a ser importada, que pode ser obtido conforme descrito em Obtendo as Configurações das Interfaces. O parâmetro de entrada file deverá ser informado, obrigatoriamente, com o arquivo da interface para upload da lista de registros a serem importados que, por sua vez, poderá opcionalmente estar compactado no padrão ZIP, opção fortemente recomendada principalmente na importação de interfaces com grandes quantidades de registros, por questões de otimização de performance. Se o arquivo informado não for válido, um código de erro 400 (ver Tratamento de Erros no link seudominio.cobransaas.com.br/#/docs-api/introducao/tratamento-erros) será retornado com a mensagem "Required request part 'file' is not present".
Se a importação da interface for iniciada com sucesso, será retornado um código de status 200 (OK), a resposta padrão para requisições HTTP bem sucedidas e, neste caso, o método retornará, no atributo id, o identificador do processo batch correspondente à importação da interface cuja execução foi iniciada. No objeto configInterface são retornadas todas as informações da configuração da interface, descritas em Obtendo as Configurações das Interfaces, cuja execução foi iniciada. No atributo dataCriacao o método retorna a data e hora de criação do processo batch e no atributo situacao o método retorna a situação da execução do processo batch que, neste caso, sempre será "INICIANDO".
Uma vez que este método é assíncrono, o andamento e a conclusão da execução do processo batch correspondente à importação da interface cuja execução foi iniciada poderá ser verificado conforme descrito em Obtendo Informações sobre o Processamento das Interfaces, utilizando o atributo id que for retornado por este método.
Exemplos de chamada e de retorno deste método da Interfaces API constam na pasta Interfaces API do arquivo Processos Batch.postman_collection.json e exemplos de arquivos de interface constam no arquivo Processos Batch.Interface.zip, disponíveis como anexos em Integrando Sistemas com os Processos Batch.
0 Comentários