Appearance
路况栅格图
本文档介绍了路况栅格图API的详细使用方法。
接口说明
路况栅格图API用于获取指定位置和缩放级别的路况图片,以PNG格式返回。该接口支持GET和POST两种请求方式。
接口描述
通过GET方式获取路况栅格图。
请求方式
| URL | 请求方式 |
|---|---|
| https://lbs.xiaojukeji.com/api/v2/traffic/raster | GET/POST |
请求
查询参数(GET)
| 参数名 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| key | query | string | 是 | 鉴权用的 API Key |
| city | query | string | 是 | 城市名称,例如:北京市 |
| x | query | number | 是 | 瓦片坐标 x |
| y | query | number | 是 | 瓦片坐标 y |
| z | query | number | 是 | 层级 |
请求体参数(POST)
| 参数名 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| key | query | string | 是 | 鉴权用的 API Key |
| request | body | object | 是 | 路况栅格图请求参数, 见models.TrafficRasterRequest |
请求示例
GET
shell
curl -X GET "https://lbs.xiaojukeji.com/api/v2/traffic/raster?key=YOUR_API_KEY&city=北京市&x=843&y=414&z=10"POST
shell
curl -X POST "https://lbs.xiaojukeji.com/api/v2/traffic/raster?key=YOUR_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"city": "北京市",
"x": 843,
"y": 414,
"z": 10
}'TIP
请求参数中的瓦片坐标(x,y)和缩放级别(z)需要符合标准瓦片规范。
响应
| 状态码 | 响应类型 | 说明 |
|---|---|---|
| 200 | image/png | PNG图片 |
| 404 | object | 请求瓦片错误,返回models.BadResponse |
TIP
返回的是PNG格式的图片,请注意正确处理响应内容类型。