Saltar al contenido principal
POST
/
v1
/
batches
Einen neuen Batch starten
curl --request POST \
  --url https://api.olostep.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "custom_id": "product-123",
      "url": "https://example.com/product/123",
      "metadata": {
        "source": "catalog_sync",
        "priority": "high"
      }
    },
    {
      "custom_id": "product-456",
      "url": "https://example.com/product/456"
    }
  ],
  "country": "US",
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "initiated_by": "automation"
  }
}
'
{
  "id": "batch_abc123def456",
  "object": "batch",
  "status": "in_progress",
  "created": 1704067200,
  "total_urls": 2,
  "completed_urls": 0,
  "country": "US",
  "metadata": {
    "batch_name": "Q1 Product Sync",
    "initiated_by": "automation"
  }
}
Recibe notificaciones al completar: Pasa el parámetro webhook con la URL de tu endpoint para recibir un HTTP POST cuando el lote se complete. Consulta Webhooks para más detalles.
Adjunta datos personalizados: Usa el parámetro metadata para almacenar pares clave-valor. Se admite en dos niveles:
  • Nivel de lote — en el cuerpo de la solicitud
  • Nivel de ítem — en cada ítem en el array items
Consulta Metadata para más detalles.

Autorizaciones

​
Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cuerpo

application/json
​
items
object[]
requerido

Array von Elementen, die im Batch verarbeitet werden sollen.

​
country
string

Land für die Batch-Ausführung. Geben Sie in ISO 3166-1 Alpha-2-Codes an, wie US(USA), IN(Indien) usw.

​
parser
object

Sie können diesen Parameter verwenden, um den zu verwendenden Parser anzugeben. Parser sind nützlich, um strukturierten Inhalt aus Webseiten zu extrahieren. Olostep hat einige Parser für die gängigsten Webseiten eingebaut, und Sie können auch Ihre eigenen Parser erstellen.

​
links_on_page
object

Alle auf jeder Seite im Batch vorhandenen Links abrufen.

​
metadata
object

Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen (keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte als Zeichenfolgen gespeichert.

Ejemplo:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string<uri>

HTTPS-URL, um eine POST-Anfrage zu erhalten, wenn das Batch abgeschlossen ist. Muss eine öffentlich zugängliche URL mit dem Protokoll http:// oder https:// sein. Kann nicht auf localhost oder private IP-Adressen verweisen. Siehe Webhooks für das Payload-Format und das Wiederholungsverhalten.

Respuesta

Batch erfolgreich gestartet.

​
id
string

Batch-ID

​
object
string

Die Art des Objekts. "batch" für diesen Endpunkt.

​
status
string

in_progress oder completed

​
created
number

Erstelltes Epochendatum

​
total_urls
number

Anzahl der URLs im Batch

​
completed_urls
number

Anzahl der abgeschlossenen URLs

​
parser
string
​
country
string
​
metadata
object

Satz von Schlüssel-Wert-Paaren zur Speicherung zusätzlicher Informationen über ein Objekt. Folgt dem Ansatz von Stripe mit Validierungsregeln: maximal 50 Schlüssel, Schlüssel maximal 40 Zeichen (keine eckigen Klammern), Wert maximal 500 Zeichen, alle Werte als Zeichenfolgen gespeichert.

Ejemplo:
{
  "order_id": "12345",
  "customer_name": "John Doe",
  "priority": "high",
  "processed": "true"
}
​
webhook
string

Webhook-URL, um eine Abschlussbenachrichtigung zu erhalten