跳转到主要内容
GET
/
v1
/
maps
/
{map_id}
Karte abrufen
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>"
}

描述

此端点允许您通过提供地图的唯一标识符 map_id 来检索地图的详细信息。

HTTP 请求

GET /v1/maps/{map_id}

路径参数

  • map_id (字符串): 要检索的地图的唯一标识符。

响应

成功的响应将返回一个包含地图详细信息的 JSON 对象。

响应示例

{
  "id": "12345",
  "name": "城市地图",
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-02T12:00:00Z"
}

错误

如果提供的 map_id 无效或地图不存在,将返回一个错误响应。

错误响应示例

{
  "error": "地图未找到",
  "status": 404
}

参见

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

路径参数

map_id
string
必填

Eindeutiger Bezeichner für die abzurufende Karte.

响应

Erfolgreiche Antwort mit dem Kartenobjekt.

id
string

Eindeutiger Bezeichner für diese Karte

urls_count
integer

Anzahl der URLs in der aktuellen Antwort

urls
string[]

Array von URLs, die auf der Seite gefunden wurden

cursor
string | null

Paginierungscursor, um den nächsten Satz von URLs abzurufen. Wenn null, wurden alle URLs abgerufen.