Skip to main content

路书 API

路书模块 api

通过GPX创建路书​

通过上传 GPX 文件，创建一条新的路书

POST /openapi/v1/routes/gpx/​

请求参数​

参数类型含义备注
title字符串路书标题最长100字符
desc字符串路书描述最长800字符（可空）
uuid字符串唯一标识最长36字符
sport整数运动类型1:WALK 2:RUN 3:CYCLE 4:OTHER
distance浮点型路书距离单位 M
gpx_filefilegpx文件非空文件, 最大支持300M

成功响应 HTTP 200​

{
  "code": 0,
  "msg": "Succcess",
  "data": {"id": 123} // 新创建的路书id
}

异常响应​

HTTP 400 gpx文件不合法

路书GPX​

获取路书的gpx文件, 响应以文件形式返回

GET /openapi/v1/routes/<id>/gpx/​

请求参数​

参数位置含义备注
idpath路书id

成功响应 HTTP 200​

异常响应​

找不到对应gpx文件 HTTP 404

获取用户收藏路书列表​

获取用户收藏的路书列表

GET /openapi/v1/routes/collects/​

请求参数​

参数位置含义备注
offsetquery获取偏移量从0开始
limitquery获取个数从1开始,最大值为20

响应参数​

字段名类型含义备注
count整型总条数返回用户收藏路书总数
previous字符串上一页链接没有上一页返回null
next字符串下一页链接没有下一页返回null
results数组记录列表没有数据返回空列表
id整型路书id
distance整型路书距离
sport整型运动类型3: 骑行
title字符串标题
desc字符串描述
create_time整型创建时间时间戳(单位为ms)
modify_time整型更新时间时间戳(单位为ms)

响应示例​

{
  "count": 10,
  "next": "https://example.com/next_page",
  "previous": "https://example.com/previous",
  "results": [
    {
      "id": 1,
      "distance": 1200,
      "sport": 3,
      "title": "string",
      "desc": "string",
      "create_time": 1729565405000,
      "modify_time": 1729595405000
    }
  ]
}

获取用户创建路书列表​

获取用户创建的路书列表

GET /openapi/v1/routes/mine/​

请求参数​

参数位置含义备注
offsetquery获取偏移量从0开始
limitquery获取个数从1开始,最大值为20

响应参数​

字段名类型含义备注
count整型总条数返回用户收藏路书总数
previous字符串上一页链接没有上一页返回null
next字符串下一页链接没有下一页返回null
results数组记录列表没有数据返回空列表
id整型路书id
distance整型路书距离
sport整型运动类型3: 骑行
title字符串标题
desc字符串描述
create_time整型创建时间时间戳(单位为ms)
modify_time整型更新时间时间戳(单位为ms)

响应样例​

{
  "count": 10,
  "next": "https://example.com/next_page",
  "previous": "https://example.com/previous",
  "results": [
    {
      "id": 1,
      "distance": 1200,
      "sport": 3,
      "title": "string",
      "desc": "string",
      "create_time": 1729565405000,
      "modify_time": 1729595405000
    }
  ]
}

获取路书导航json数据​

获取路书导航数据,以json的格式返回

GET /openapi/v1/routes/<id>/raw/​

请求参数​

参数位置含义备注
idpath路书id

响应参数​

字段名类型含义备注
id整型路书id
name字符串标题
description字符串描述
distance整型路书距离
version字符串2.0.0常量
route_type整型路书类型
create_at整型创建时间时间戳(单位为ms)
modify_at整型更新时间时间戳(单位为ms)
elevation_gain浮点型爬升精度两位小数点
elevation_loss浮点型落降精度两位小数点
distances数组距离数组元素为浮点型
elevations数组高程数组元素为整型
polylines数组polyline对象数组
steps数组step对象数组
step.direction_source字符创导航来源如：google
step.transport_type字符串交通类型如：bike
step.instruction字符串导航说明
step.street_name字符串街道名称
step.maneuver整型导航动作参考google导航maneuver
step.from整型起始距离
step.to整型结束距离
waypoints数组waypoint对象数组
waypoint.name字符串waypoint标题
waypoint.description字符串waypoint描述
waypoint.elevation整型waypoint高程
waypoint.distance浮点型waypoint距离
waypoint.hidden布尔型是否隐藏
waypoint.function字符串未知
waypoint.coordinate数组经纬度坐标[31.220055,120.381475]
pois数组POI对象数组
poi.latitude浮点型纬度
poi.longitude浮点型经度
poi.elevation整型高程
poi.create_time整型创建时间时间戳(单位为ms)
poi.pic_url字符串图片链接
climbs数组爬坡对象数组
climb.category字符串爬坡等级HC1234坡度
climb.start_index整型开始爬坡位置索引
climb.end_index整型开始爬坡位置索引
climb.max_grade浮点型最大坡度(0, 1)
climb.distance浮点型爬坡距离
climb.elevation_gain整数爬升
climb.score浮点型未知

通用异常响应 Error Response​

400​

{
  "code": 400,
  "msg": "API Limited",
  "data": {}
}

401​

{
  "code": 401,
  "msg": "Unauthorized Error",
  "data": {}
}

500​

{
  "code": 500,
  "msg": "Server Error",
  "data": {}
}