# 概述
高精度感知服务向开发者提供 https API,开发者可通过 https 请求使用相关高精度感知服务功能。 具体可查看API文档 (opens new window)。
# 服务地址
服务地址:https://openapi.starcart.cn/pro/v1,支持 https,以 POST 或 GET 方式进行请求,返回结果为 json 数据格式。
# 请求返回值
请求返回值为一个 json 对象,格式如下:
{
"code": xxx,
"result": [{xxxx}],
"msg": "xxx"
}
1
2
3
4
5
2
3
4
5
名称 | 描述 | 值 |
---|---|---|
code | 状态码 | 1000,调用成功,调用结果符合预期。 非1000,调用失败,调用结果不符合预期。 |
result | 返回数据 | 当code为1000时,result 不为空,是调用结果的 json 格式数据。 当 code 不为1000时,则 result 为 null。 |
msg | 状态信息描述 | 对调用结果 code 的文字说明。 |
# 状态码
code | msg | 说明 |
---|---|---|
1003 | Missing param | 缺失参数 |
1004 | Invalid param | 无效参数 |
# API说明
以下以感知服务接口示例
1. 获取全局唯一接口访问令牌
通过凭证和凭证秘钥获取全局唯一接口访问令牌: (1)token的有效期目前为2个小时,需定时刷新,重复获取将导致上次获取的token在5分钟后失效,以保证第三方业务的平滑过渡; (2)该接口日调用次数最多为1000次
? 请求地址:token/get
? 请求方式:GET
? 请求参数:
参数名 | 类型 | 必填 | 描述 | 默认值 |
---|---|---|---|---|
key | string | 是 | 第三方用户唯一凭证 | -- |
secret | string | 是 | 第三方用户唯一凭证密钥 | -- |
? 返回正确显示示例:
{
"code": 1000,
"result": {
"token": "elJrbGtVY05VN1VMVFBSUkp0ZzFWNjdHdFROUFpkTUwrclZSeXdiTUpGRU01SStEZ0FIbmhKK29Td0
NmUUdleFdEWlJiN0J4Z05zcXpnNXVmZkRxR3hVbE8zYmNrcHpmS3JQQWp0VWt4cVJpWVArK1p4bGlM
SW9uWDg1cFBEZTBCcXk4aGZjUnNnYXJHa0VTSEJiQU10bXBRem10VCtYM25NSERnYStjbUpnPQ",
"expires": 7200
},
"msg": "Success"
}
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
? 返回错误结果示例:
{
"code": 1004,
"msg": "Invalid param"
}
1
2
3
4
2
3
4
? 返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
token | string | 访问令牌 |
expires | long | 有效期,单位:秒 |
? 状态码:
code | msg | 说明 |
---|---|---|
1000 | Success | 成功 |
1003 | Missing param | 参数缺失 |
1004 | Invalid param | 无效参数 |
1005 | Invalid request version | 无效的请求 |
1008 | Server busy | 服务器繁忙 |
1009 | Failed | 服务异常 |
1010 | Access exceeded | 访问次数超限(日限1000) |
8003 | Key does not match secret | key和secret不匹配 |
2. 查询应用下毫米级指定监测站点信息
通过访问令牌和站点编码查询应用下毫米级指定监测站点信息
? 请求地址:mmstation/query
? 请求方式:GET
? 请求参数:
参数名 | 类型 | 必填 | 描述 | 默认值 |
---|---|---|---|---|
token | string | 是 | 访问令牌 | -- |
deviceIds | string | 是 | 一个或多个监测站点编码,以逗号(,)分隔,最大值为100 | -- |
? 返回正确显示示例:
{
"code": 1000,
"result": {
"items": [
{
"deviceId": "866",
"name": "站点1",
"lon": 119.329395134,
"lat": 41.037306463,
"alt": 53.7138,
"createTime": 1610346630000,
"updateTime": 1611126181000
}
],
"total": 1
},
"msg": "Success"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
? 返回错误结果示例:
{
"code": 1004,
"msg": "Invalid param"
}
1
2
3
4
2
3
4
? 返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
items | list | 监测站点信息 |
total | int | 数据总条数 |
? 状态码:
code | msg | 说明 |
---|---|---|
1000 | Success | 成功 |
1003 | Missing param | 参数缺失 |
1004 | Invalid param | 无效参数 |
1005 | Invalid request | 无效的请求 |
1008 | Server busy | 服务器繁忙 |
1009 | Failed | 服务异常 |
9001 | Token is expired | Token已过期 |
9003 | Token is invalid | 无效的Token |