跳转到主要内容
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"
  }
}
完成时获取通知： 传递 webhook 参数以及您的端点 URL，以便在批处理完成时接收 HTTP POST。详情请参见Webhooks。
附加自定义数据： 使用 metadata 参数存储键值对。支持两个级别：
  • 批处理级别 — 在请求主体中
  • 项目级别 — 在 items 数组中的每个项目上
详情请参见Metadata。

授权

​
Authorization
string
header
必填

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

请求体

application/json
​
items
object[]
必填

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.

示例:
{
  "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.

响应

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.

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

Webhook-URL, um eine Abschlussbenachrichtigung zu erhalten