Batch API

Algumas APIs da Plataforma suportam operações que podem ser feitas em lote, ou seja, a mesma operação várias vezes utilizando um Payload maior. A operação em lote pode ser tanto para o envio de várias informações em lote, ou para a leitura de várias informações. Exemplo, você pode utilizar este recurso para salvar vários produtos de uma vez ou para recuperar vários cadastros de uma vez

Leitura Páginada

Geralmente todas as APIs na Plataforma que suportam o recurso em lote, obrigam a utilização do recurso de paginação para quando é realizado a consulta dos registros. Para isso é necessário obter os dados de paginação, isso pode ser feito chamando a rota normalmente se configuração nenhuma, Exemplo:

• Parâmetros: 
  • Somente o Corpo
• Requer Autenticação: Não
• Método: POST
• Tipo de Retorno:  Void | TObjeto
• Headers:
  • API_TOKEN: Token de Segurança
  • ACCEPT: application/json

A Resposta será:

Agora pode realizar a consulta com a paginação, para isso iremos informar a quantidade de registros que queremos e de que ponto irá começar, Exemplo:

Se temos 11 Registros e queremos buscar os 5 primeiros, realizamos a seguinte operação:

• Parâmetros na URI:
• Nenhum Corpo: Vazio
• Método: GET
• Headers:
  • API_TOKEN: Token recuperado pela Autenticação
  • Accept: application/json
  • paginacao.tamanho: 5
  • paginacao.comecarem: 0

A Resposta será os 5 primeiros registros

Se temos 11 Registros e queremos buscar os 5 da segunda página, realizamos a seguinte operação:

• Parâmetros na URI:
• Nenhum Corpo: Vazio
• Método: GET
• Headers:
  • API_TOKEN: Token recuperado pela Autenticação
  • Accept: application/json 
  • paginacao.tamanho: 5
  • paginacao.comecarem: 5

A Resposta será 5 registros, depois que a rotina pular os 5 primeiros registros.

Importante: 

• Operação em Lote podem causar Timeout se caso o cliente esteja configurado com os valores padrões de Timeout.
• Payload muito grandes ou paginações muito grandes podem ocasionar quebra de informação, timeout ou erros de requisição como Bad Request.