跳转到主要内容
POST
/
v1
/
batches
启动新批处理
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 认证头的格式为 Bearer ,其中 是你的认证令牌。

请求体

application/json
items
object[]
必填

要在批处理中处理的项目数组。

country
string

批处理执行的国家。请以 ISO 3166-1 alpha-2 代码提供,如 US(美国)、IN(印度)等。

parser
object

你可以使用这个参数来指定要使用的解析器。解析器对于从网页中提取结构化内容非常有用。Olostep 内置了一些常见网页的解析器,你也可以创建自己的解析器。

获取批处理中每个页面上存在的所有链接。

metadata
object

用于存储对象附加信息的键值对集合。遵循 Stripe 的验证规则:最多 50 个键,键最多 40 个字符(不含方括号),值最多 500 个字符,所有值以字符串形式存储。

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

当批处理完成时接收 POST 请求的 HTTPS URL。必须是使用 http://https:// 协议的公开可访问的 URL。不能指向 localhost 或私有 IP 地址。有关负载格式和重试行为,请参阅 Webhooks

响应

批处理启动成功。

id
string

批处理 ID

object
string

对象的类型。此端点为 "batch"。

status
string

in_progresscompleted

created
number

创建的纪元时间

total_urls
number

批处理中 URL 的数量

completed_urls
number

已完成的 URL 数量

parser
string
country
string
metadata
object

用于存储对象附加信息的键值对集合。遵循 Stripe 的验证规则:最多 50 个键,键最多 40 个字符(不含方括号),值最多 500 个字符,所有值以字符串形式存储。

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

用于接收完成通知的 Webhook URL