メインコンテンツへスキップ
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 パラメータを使用してキーと値のペアを保存します。2つのレベルでサポートされています:
  • バッチレベル — リクエストボディに
  • アイテムレベルitems 配列内の各アイテムに
詳細はMetadataを参照してください。

承認

Authorization
string
header
必須

Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。

ボディ

application/json
items
object[]
必須

バッチで処理されるアイテムの配列。

country
string

バッチ実行の国。ISO 3166-1 alpha-2コードで提供してください。例: US(USA), IN(India)など。

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_progress または completed

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