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"
]
}承認
Bearer認証ヘッダーの形式はBearer で、はあなたの認証トークンです。
ボディ
リンクを取得したいウェブサイトのURL
検索の関連性でリンクをソートするためのオプションの検索クエリ。
検索クエリに対して上位nリンクのみに制限するためのオプションの数。
指定されたURLのサブドメインを含める。デフォルトはtrue。
グロブ構文を使用して含めるURLパスパターン。例えば、/blog/**はブログのURLのみを含めます。これらのパターンに一致するURLのみが返されます。
グロブ構文を使用して除外するURLパスパターン。例えば、/careers/**。除外されたURLは含まれるURLより優先されます。
オプション: 前のレスポンスからのページネーションカーソル。指定された場合、前回のリクエストがレスポンスサイズ制限のために終了した場所から次のURLセットを返します。
レスポンス
ページ上で見つかったURLを含む成功したレスポンス
現在のレスポンスに含まれるURLの数
ページ上で見つかったURLの配列
この地図の一意の識別子
10MBのサイズ制限のために制限された次のURLセットを取得するためのページネーションカーソル。nullまたは存在しない場合、すべてのURLが取得されています。
このリクエストで消費されたクレジットの数。実行完了後に入力されるよ。クレジットは請求の真実の源だよ。
このリクエストのUSDでの推定コスト。実行完了後に入力されるよ。消費されたクレジットとあなたのプランレートから計算されるよ — 99% 正確だけど、credits_consumed が権威ある値だよ。
このページは役に立ちましたか？