Os sistemas que estão integrados aos processos batch da plataforma CobranSaaS podem iniciar a execução do Processamento Global Diário através do método assíncrono Batch API - Processar global, cuja documentação está disponível no link seudominio.cobransaas.com.br/#/docs-api/batch/api-batch-processar, onde a expressão "seudominio" deverá ser substituída nesta URL pelo domínio utilizado por sua empresa na plataforma CobranSaaS.
O parâmetro de entrada dataProcessamento deve ser informado, obrigatoriamente, com a próxima data a ser processada que, necessariamente, deverá ser o dia seguinte à Data de Processamento Atual que, por sua vez, poderá ser obtida conforme descrito em Obtendo as Configurações Globais. Se a data informada não for válida, 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 "A data do processamento não é valida".
Se a execução do Processamento Global Diário 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 retorna, no atributo id, o identificador do processo batch correspondente ao Processamento Global Diário 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".
O andamento e a conclusão da execução do processo batch correspondente ao Processamento Global Diário cuja execução foi iniciada poderão ser verificados, considerando a última execução do Processamento Global Diário, conforme descrito em Obtendo Informações sobre o Processamento Global Diário.
Um exemplo de chamada e de retorno deste método consta na pasta Batch API do arquivo Processos Batch.postman_collection.json, disponível como anexo em Integrando Sistemas com os Processos Batch.
Comentários
0 comentário
Artigo fechado para comentários.