Os sistemas integrados aos processos batch da plataforma CobranSaaS podem importar dados de várias entidades (agrupadores, produtos, clientes, contratos etc.) via métodos assíncronos da Batch API específicos para cada entidade.
A lista de registros deve estar em JSON, com cada registro em uma linha válida individualmente. O arquivo não deve conter os caracteres de início ("["), separadores (",") ou fim ("]") de lista, para otimizar o processamento que lê um registro por vez.
Os métodos assíncronos permitem enviar registros no corpo da requisição como uma string (para poucos registros) ou como arquivo para upload (para grandes volumes).
Os atributos obrigatórios e opcionais de cada entidade estão na documentação do método correspondente.
O atributo id (Id Externo) é obrigatório para todas as entidades, exceto para bloqueios e desbloqueios. Ele identifica unicamente o registro na origem e define se o registro será inserido (INSERT) ou atualizado (UPDATE) na plataforma.
Além de inserir e atualizar, os métodos assíncronos para as entidades aplicações, contratos, notas fiscais e saldos permitem exclusão (DELETE) de registros existentes, se os parâmetros opcionais full (Boolean) e comparador forem informados na URL.
Se full for true, a importação será completa: todos os registros do arquivo serão inseridos ou atualizados e os registros existentes que não estiverem no arquivo serão excluídos, desde que seus ids atendam ao critério do comparador. Caso full seja true e comparador não informado, será retornado erro 400 com a mensagem "O comparador deve ser informado quando for importação full".
Exemplos de comparador: "CC_%" exclui registros com id iniciando com "CC_"; "%_CC" exclui registros com id terminando com "_CC"; "%CC%" exclui registros com "CC" em qualquer posição do id.
Para importar via arquivo, o parâmetro file é obrigatório e pode estar compactado em ZIP, recomendado para grandes volumes. Arquivos inválidos geram erro 400 com a mensagem "O arquivo não foi informado corretamente".
Ao iniciar a importação com sucesso, o método retorna status 200 (OK), com o id do processo batch, a data de criação (dataCriacao) e a situação (situacao), que será "INICIANDO".
Como os métodos são assíncronos, o progresso e conclusão da importação podem ser consultados usando o id do processo, conforme descrito nos tópicos Obtendo Informações sobre o Processamento das Importações e Obtendo os Registros Ignorados nas Importações.I
Exemplos de chamada e de retorno dos métodos da Batch API para cada tipo de entidade importada constam na pasta Batch API do arquivo Processos Batch.postman_collection.json e exemplos de arquivos de importação para cada tipo de entidade constam no arquivo Processos Batch.Importação.zip, disponíveis como anexos em Integrando Sistemas com os Processos Batch.
Comentários
0 comentário
Artigo fechado para comentários.