curl --request POST \
--url https://api.olostep.com/v1/maps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://docs.olostep.com"
}
'{
"id": "map_abc123",
"urls_count": 22,
"urls": [
"https://docs.olostep.com/api-reference/batches/create",
"https://docs.olostep.com/api-reference/batches/info",
"https://docs.olostep.com/api-reference/batches/items"
]
}マップの作成
このエンドポイントは、特定のウェブサイト上のすべてのURLを取得することを可能にします。複雑なウェブサイトの場合、最大120秒かかることがあります。大規模なウェブサイトの場合、結果はカーソルベースのページネーションを使用してページ分けされます。
curl --request POST \
--url https://api.olostep.com/v1/maps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://docs.olostep.com"
}
'{
"id": "map_abc123",
"urls_count": 22,
"urls": [
"https://docs.olostep.com/api-reference/batches/create",
"https://docs.olostep.com/api-reference/batches/info",
"https://docs.olostep.com/api-reference/batches/items"
]
}storage.expires_in を渡すことで、このマップの保存ファイルをデフォルトの7日間より長く保持できます。値: 7d, 10d, 30d, 60d, 90d, 180d, 365d, または never。詳細はストレージを参照してください。承認
Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。
ボディ
リンクを取得したいウェブサイトのURL
このマップの保存されたファイル（その結果と発見中にスクレイプされたページ）がどのくらいの期間保持されるかを制御します。省略された場合、7日間保持されます。実際の値はレスポンスでstorage.expires_inとして返されます。機能ドキュメントのストレージセクションを参照してください。無効な値は、コードinvalid_storage_expires_inで400を返します。
Show child attributes
Show child attributes
検索の関連性でリンクをソートするためのオプションの検索クエリ。
検索クエリの上位nリンクのみに制限するためのオプションの数。
指定されたURLのサブドメインを含めます。デフォルトではtrueです。
グロブ構文を使用して含めるURLパスパターン。例えば、/blog/**はブログURLのみを含めます。これらのパターンに一致するURLのみが返されます。
グロブ構文を使用して除外するURLパスパターン。例えば、/careers/**。除外されたURLは含まれるURLよりも優先されます。
オプション: 前のレスポンスからのページネーションカーソル。これを提供すると、レスポンスサイズの制限で前回のリクエストが終了した場所から次のURLセットを返します。
レスポンス
ページ上で見つかったURLを含む成功したレスポンス
現在のレスポンスに含まれるURLの数
ページ上で見つかったURLの配列
このマップの保存されたファイルに適用される保持。
Show child attributes
Show child attributes
このマップの一意の識別子
10MBのサイズ制限のために制限された次のURLセットを取得するためのページネーションカーソル。nullまたは存在しない場合、すべてのURLが取得されています。
このリクエストで消費されたクレジットの数。実行完了後に入力されるよ。クレジットは請求の真実の源だよ。
このリクエストのUSDでの推定コスト。実行完了後に入力されるよ。消費されたクレジットとあなたのプランレートから計算されるよ — 99%の精度だけど、credits_consumedが権威ある値だよ。
このページは役に立ちましたか？