水域预警 API
全国范围的水域信息和预警服务。
1 概述
提供融合定位等接口。协议默认规格有:
1、时间戳为int64,采用unix 时间戳(Unix epoch),单位为毫秒;
2、字符串都为UTF8 格式;
3、HTTP Headers:Content-Type 设置为:application/json
鉴权方式:
采用access_key 的方式,在URL 的Query Param 中添加access_key。
2危险水域接口
输入经纬度和半径,返回垂直距离在半径范围内的水域的地址数据、geojson,以及垂直距离。
2.1 请求参数
定位结果的获取,通过GET 请求下面的URL :
https://api.newayz.com/location/scenario/v1/danger_sites?access_key={YOUR_ACCESS_KEY}&type=waters&location=113.103815,32.396826&radius=1000
请求参数:
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| access_key | string | 是 | 调用API 所需的Key |
| type | string | 是 | 危险水域类型,目前只支持传:waters |
| location | string | 是 | 经纬度,坐标系是gcj02,格式如: 121.604563,31.179709 |
| radius | int | 否 | 半径,默认值 300 米 |
调用WAYZ 的API,需要提前获取KEY 信息。
2.2 返回参数
参数类型必须说明
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| id | string | 是 | 调用API 所需的Key |
| geometry | GeoJSON | 是 | GeoJSON 格式数据,参考 GeoJSON 协议 |
| geoPoint | string | 是 | 经纬度,格式如:121.604563,31.179709 |
| type | string | 是 | 水域类型,示例:湖泊池塘 |
| address | Address | 是 | 结构化地址 |
| distanceMeters | float64 | 是 | 请求经纬度距离水域边界的最短垂直距离 |
返回参数是一个数组,示例如下:
[
{
"id": "77d26f596c5395c0cc715e7504adf9d1",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
113.102486,
32.404223
],
[
113.102279,
32.404165
],
[
113.102123,
32.404151
],
[
113.102002,
32.404162
],
[
113.101914,
32.404202
],
[
113.10189,
32.404257
],
[
113.101938,
32.404307
],
[
113.10211,
32.404377
],
[
113.10252,
32.404544
],
[
113.102709,
32.404616
],
[
113.102876,
32.404709
],
[
113.102951,
32.404748
],
[
113.103004,
32.404762
],
[
113.103043,
32.40476
],
[
113.103068,
32.404745
],
[
113.103086,
32.404703
],
[
113.103123,
32.404513
],
[
113.103106,
32.404474
],
[
113.103073,
32.404409
],
[
113.103051,
32.404342
],
[
113.102981,
32.404206
],
[
113.102955,
32.404125
],
[
113.10293,
32.404
],
[
113.102871,
32.40372
],
[
113.102835,
32.403641
],
[
113.102792,
32.403604
],
[
113.102749,
32.403596
],
[
113.102714,
32.403601
],
[
113.102689,
32.403615
],
[
113.102673,
32.403653
],
[
113.102676,
32.403904
],
[
113.102671,
32.404023
],
[
113.102651,
32.404128
],
[
113.102622,
32.404178
],
[
113.102577,
32.404209
],
[
113.102545,
32.404232
],
[
113.102516,
32.404237
],
[
113.102486,
32.404223
]
]
]
},
"geoPoint": "113.102660874,32.404277864",
"type": "湖泊池塘",
"address": {
"name": "河南省南阳市桐柏县",
"context": [
{
"type": "Province",
"name": "河南省"
},
{
"type": "City",
"name": "南阳市"
},
{
"type": "District",
"name": "桐柏县"
}
]
},
"distanceMeters": 757.070551
}
]
2.3 报错信息
| 错误参数 | 说明 |
|---|---|
| 400 | 参数异常 |
| 401 | Appkey非法或不存在 |
| 403 | Appkey 权限异常 |
| 404 | 无法解析 |
| 529 | 请求次数超额 |
| 500 | 服务器异常 |
400 报错信息:
{
"code": "400",
"message": "no refdata provided"
}
401 报错信息:
{
"code": "401",
"message": "No API key found in request"
}
403 报错信息:
{
"code": "403",
"message": "Access key forbidden"
}
404 报错信息:
{
"code": "404",
"message": "scenario not found"
}
429 报错信息:
{
"code": "429",
"message": "API rate limit exceeded"
}
