# 概述
高精度实时定位服务向开发者提供 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 的信息 |