メインコンテンツへスキップ
GET
/
v1
/
maps
/
{map_id}
マップを取得
curl --request GET \
  --url https://api.olostep.com/v1/maps/{map_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "urls_count": 123,
  "urls": [
    "<string>"
  ],
  "cursor": "<string>"
}

​
マップを取得

このエンドポイントを使用して、特定のマップの詳細を取得します。

​
リクエスト

​
HTTP リクエスト

GET /v1/maps/{map_id}

​
パスパラメータ

  • map_id: 取得したいマップの一意の識別子。

​
レスポンス

成功した場合、このメソッドはマップオブジェクトを返します。

​
レスポンスボディ

{
  "id": "123",
  "name": "Sample Map",
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-02T00:00:00Z"
}

​
エラー

  • 404 Not Found: 指定された map_id のマップが存在しない場合。
  • 401 Unauthorized: 認証されていない、または無効なトークンを使用している場合。

​
例

​
リクエストの例

GET /v1/maps/123 HTTP/1.1
Host: api.olostep.com
Authorization: Bearer your-access-token

​
レスポンスの例

{
  "id": "123",
  "name": "Sample Map",
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-02T00:00:00Z"
}
このエンドポイントを使用することで、マップの詳細を簡単に取得できます。

承認

​
Authorization
string
header
必須

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

パスパラメータ

​
map_id
string
必須

取得するマップのユニークな識別子。

レスポンス

マップオブジェクトを含む成功したレスポンス。

​
id
string

このマップのユニークな識別子

​
urls_count
integer

現在のレスポンスに含まれるURLの数

​
urls
string[]

ページ上で見つかったURLの配列

​
cursor
string | null

次のURLセットを取得するためのページネーションカーソル。nullの場合、すべてのURLが取得されています。