batch +
Endpoint para gestionar las peticiones batch. Está compuesto por una colección de recursos que permiten realizar y consultar la ejecución de peticiones batch.
</> POST / batchRecurso para realizar múltiples peticiones individuales en una única petición POST a /v1/batch, mejorando la eficiencia y reduciendo el tiempo de respuesta.
</> GET / batch/{uuid}Devuelve la información actual del proceso. En todo momento se puede consultar el estado de la petición batch. La información del proceso estará disponible durante 1 hora. Pasado este tiempo, podrás descargar el contenido de la respuesta mediante la llamada a GET - /batch/{uuid}/file
</> GET / batch/{uuid}/gzDescarga un archivo comprimido que contiene las respuestas de todas las operaciones realizadas durante el proceso batch, en formato JSONL. La descompresión del archivo revela el contenido en su formato original. La descarga del fichero estará disponible durante 24 horas.
</> GET / batch/{uuid}/jsonlDescarga un archivo en formato JSONL (JSON Lines) que almacena las respuestas de todas las operaciones realizadas durante el proceso batch. La descarga del fichero estará disponible durante 24 horas.
</> GET / batch/limitsDevuelve la información de los puntos de carga de cada endpoint disponible en la api.
POST /batch
Descripción
Recurso para realizar múltiples peticiones individuales en una única petición POST a /v1/batch, mejorando la eficiencia y reduciendo el tiempo de respuesta.

Para garantizar un uso eficiente de la API Batch, es fundamental tener en cuenta los puntos de carga asignados a cada recurso. La suma de los puntos de carga de todas las operaciones en el cuerpo de la solicitud no debe superar el máximo permitido. Los puntos de carga pueden variar con el tiempo, por lo que se recomienda utilizar el recurso GET - /v1/batch/limits para obtener información actualizada sobre los puntos de carga de cada recurso.Estado y Seguimiento Concurrente,

La solicitud POST a /v1/batch es asincrónica, proporcionando rápidamente un identificador único de proceso (UUID). Para verificar el estado del proceso, se puede utilizar GET - /v1/batch/{uuid}, que proporciona detalles sobre si el proceso ha finalizado o está en curso, junto con información interna detallada de cada operación. Es importante destacar que el sistema controla la concurrencia y evita la ejecución simultánea de dos solicitudes batch. En caso de intentar lanzar una segunda solicitud mientras una está en proceso, el sistema informará al usuario mediante un código de error.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/batch
Parámetros de entrada JSON
{
"batch": {
"operations": [
{
"body":string,
"endpoint":string,
"method":string,
"operationId":string
}
],
"webhook": {
"callbackUrl":string,
"email":string
}
}
}
Variables JSON:
VariableR/OValor por defectoTipo
batch		Obligatoriostruct
Bloque de información de la petición batch
batch/operations		Obligatorioarray [1:n]
Bloque de información con las peticiones batch a realizar.
- Hay que tener en cuenta los puntos de carga máximos que permite el recurso.
- Para el correcto funcionamiento en las operaciones batch se ha limitado el valor máximo del parámetro 'perPage' a 100.
batch/operations/body		Opcionalstring
Cuerpo del recurso. Solo útil cuando el Método del recurso es 'POST' o 'PUT'.
batch/operations/endpoint		Obligatoriostring
Endpoint del recurso a solicitar
batch/operations/method		Obligatoriostring
Método del recurso a solicitar
batch/operations/operationId		Obligatoriostring
Identificador único de petición. Este identificador debe ser único para la llamada a este recurso. Es necesario para poder vincular una respuesta a este identificador.
batch/webhook		Opcionalstruct
Este bloque permite al usuario ser notificado directamente al finalizar el proceso batch ya sea a través de una llamada a una URL especificada en callbackUrl o mediante el envío de un correo electrónico a la dirección proporcionada.
batch/webhook/callbackUrl		Opcionalstring
Dirección URL que será llamada cuando finalice el proceso. A esta url le llegará el identificador único de petición ?uid=XXXX-XXXX-XXXX-XXXX.
batch/webhook/email		Opcionalstring
Dirección de correo electrónico que será notificado cuando finalice el proceso.
HTTP statusCode
201 CREATED
Ejemplo de respuesta
{
"uuid" :"15B9B314-81AD-417E-B16B818716933C7B"
}
GET /batch/{uuid}
anterior
Descripción
Devuelve la información actual del proceso. En todo momento se puede consultar el estado de la petición batch. La información del proceso estará disponible durante 1 hora. Pasado este tiempo, podrás descargar el contenido de la respuesta mediante la llamada a GET - /batch/{uuid}/file
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/batch/{uuid}
Parámetros de entrada URL
VariableR/OValor por defectoTipo
uuid		Obligatoriostring
Identificador único de petición batch
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"completedAt" :"2023-11-24T10:44:30Z",
"createdAt" :"2023-11-24T10:44:26Z",
"operations" : 3,
"processedAt" :"2023-11-24T10:44:27Z",
"responses": [
{
"body" :"",
"completedAt" :"2023-11-24T10:44:29Z",
"endpoint" :"/v1/products?page=1",
"method" :"GET",
"operationId" :"createProductApiBatch1",
"status" :"finished",
"statusCode" : 200,
"statusText" :"",
"uuid" :"74858C7D-4F03-4EAD-9775E56C54B40DF4"
},
{
"body" :"",
"completedAt" :"2023-11-24T10:44:29Z",
"endpoint" :"/v1/products?page=2",
"method" :"GET",
"operationId" :"createProductApiBatch2",
"status" :"finished",
"statusCode" : 200,
"statusText" :"",
"uuid" :"BB17AD87-CF57-42E3-B44083FD3DD920E9"
}
],
"status" :"finished",
"updatingAt" :"2023-11-24T10:44:28Z",
"uuid" :"7E83BA1D-B6A1-4344-B781A59CB5BD4AAF",
"webhook": {
"callbackUrl" :"https://www.callbackUrl.cfm",
"email" :"email@email.com"
}
}
GET /batch/{uuid}/gz
anterior
Descripción
Descarga un archivo comprimido que contiene las respuestas de todas las operaciones realizadas durante el proceso batch, en formato JSONL. La descompresión del archivo revela el contenido en su formato original. La descarga del fichero estará disponible durante 24 horas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/batch/{uuid}/gz
HTTP statusCode
200 OK
Ejemplo de respuesta
No Content
GET /batch/{uuid}/jsonl
anterior
Descripción
Descarga un archivo en formato JSONL (JSON Lines) que almacena las respuestas de todas las operaciones realizadas durante el proceso batch. La descarga del fichero estará disponible durante 24 horas.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/batch/{uuid}/jsonl
HTTP statusCode
200 OK
Ejemplo de respuesta
No Content
GET /batch/limits
anterior
Descripción
Devuelve la información de los puntos de carga de cada endpoint disponible en la api.
Tipo de petición
FREE
LIGHT
HEAVY
Ejemplo de recurso
http://api-sync.logicommerce.cloud/v1/batch/limits
HTTP statusCode
200 OK
Ejemplo de respuesta
{
"limits": {
"endpoints": [
{
"endpoint" :"/v1/areas/activityLimits/{id}",
"loadScore" : 1,
"method" :"delete"
},
{
"endpoint" :"/v1/areas/activityLimits/{id}",
"loadScore" : 2,
"method" :"get"
},
{
"endpoint" :"/v1/areas/activityLimits/{id}",
"loadScore" : 2,
"method" :"put"
}
],
"maxLoadScore" : 100
}
}