# 概述
高精度实时定位服务向开发者提供 https API,开发者可通过 https 请求使用定位服务功能。 具体可查看API文档 (opens new window)。
# 服务地址
服务地址:https://openapi.starcart.cn,支持 https,以 POST 或 GET 方式进行请求,返回结果为 json 数据格式。
# 请求返回值
请求返回值为一个 json 对象,格式如下:
{
"code": xxx,
"message": "xxx",
"result": [{xxxx}]
}
1
2
3
4
5
2
3
4
5
名称 | 描述 | 值 |
---|---|---|
code | 状态码 | 1000,调用成功,调用结果符合预期。 非1000,调用失败,调用结果不符合预期。 |
message | 状态信息描述 | 对调用结果 code 的文字说明。 |
result | 返回数据 | 当code为1000时,result 不为空,是调用结果的 json 格式数据。 当 code 不为1000时,则 result 为 null。 |
# 状态码
code | message | 说明 |
---|---|---|
1002 | Not found | 没有数据记录 |
1003 | Missing param | 缺失参数 |
# API说明
1. 用户登录
通过 appKey、用户名、密码登录获取访问令牌 token
? 请求地址:app/user/login
? 请求方式:GET
? 请求参数:
参数名 | 类型 | 必填 | 描述 | 默认值 |
---|---|---|---|---|
appKey | string | 是 | 应用appKey | -- |
uname | string | 是 | 用户名 | -- |
pwd | string | 是 | 密码 | -- |
deviceId | string | 是 | 设备ID | -- |
? 返回正确显示示例:
{
"code": 1000,
"message": "Success",
"result": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJleHBUaW1lIjoxNTU3NDc1NjUxMzI1LCJpc3MiOiJvcGVuQXBpIiwid
XNlck5hbWUiOiIxMzY2MDg5OTcxNiIsInVzZXJJbmZvSWQiOjgzfQ.7w3jnQ91lw8nsOKhk_b47aUo
DprVEHzv54SHn1WbMSA"
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
? 返回错误结果示例:
{
"code": 5008,
"message": "Not exist user",
"result": null
}
1
2
3
4
5
2
3
4
5
? 返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
token | string | 访问令牌 |
? 状态码:
code | message | 说明 |
---|---|---|
1000 | Success | 成功 |
1003 | Missing param | 参数缺失 |
1009 | Failure | 执行失败 |
5008 | Not exist user | 用户不存在 |
7001 | Service does not exist | 服务不存在 |
7002 | Service expired | 服务过期 |
8001 | App does not exist | 应用不存在 |
2. 获取定位服务数据
获取定位服务数据
? 请求地址: 厘米级定位 rtcm 数据:/app/service/rtk 亚米级+定位 rtcm 数据:/app/service/rtdplus 亚米级定位 rtcm 数据:/app/service/rtd
? 请求方式:GET
? 请求参数:
参数名 | 类型 | 必填 | 描述 | 默认值 |
---|---|---|---|---|
token | string | 是 | 访问令牌 | -- |
gga | string | 否 | 用户的 GGA 信息,该参数可选,如果需要获取观测电文, 则需要发送 GGA 但是不是每次都需要,至少保证上传过 GGA; | -- |
? 返回正确结果示例:
{
"code": 1000,
"message": "Success",
"result": {
"rtcmmsg": "D300133ED0BE027A95E73CB28C8BDDD52905CB781E64ABA4CED300153EE0BE03
3A95E73CB28C8BDDD52905CB781E640000252C3BD300094090BE0000000000002
3DF06D300594320BE55FF7122000001D0A11000000000200000007FA5A1A4A526
2524239E74C2E8CDEDACA62CBD00CA2E39A3078D713B024C5EA73A50400001000
004000010000040000100000400001000007FFFFFFF8063C678D7863980B5BAFF
D3003743C0BE862BC5E200000030060000000000200000007A5A222204C0475ED
7832E508B5F583508C0000100000400001000007FFF85DB6BC87301A0D3007246
40BE55FE966000007FE4000000000000200000007FF7A7C788082807A7D7C7C82
F5926F65A2E74C28ACC635738FA42700EE2318582DCBD1CC7A13B3E67C86312C2
15130000040000100000400001000004000010000040000100000400001000007
FFFFFFFFFF800C6FD2BA6ACAFBF0AC03BDBFD"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
? 返回错误结果示例:
{
"code": 10004,
"message": "No valid gga",
"result": null
}
1
2
3
4
5
2
3
4
5
? 返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
rtcmmsg | string | 电文数据 |
? 状态码:
code | message | 说明 |
---|---|---|
1000 | Success | 成功 |
1003 | Missing param | 参数缺失 |
1009 | Failure | 执行失败 |
7001 | Service does not exist | 服务不存在 |
7002 | Service expired | 服务过期 |
9001 | Token is expired | Token 已过期 |
9002 | Token is not exist, please login to get it | Token 不存在,请先登录获取 |
9003 | Token is invalid | 无效的 Token |
10003 | Invalid service type | 服务类型不正确 |
10004 | No valid gga | 无效的 GGA |
10005 | No obs message | 没有观测电文 |
10006 | No nav message | 没有导航电文 |
10007 | No message | 没有观测电文和导航电文 |
10008 | No vrs info | 不存在 VRS 的信息 |