概述 | 星舆科技-云顶国际yd888

# img 概述

高精度感知服务向开发者提供 https api,开发者可通过 https 请求使用相关高精度感知服务功能。 具体可查看api文档 (opens new window)

# img 服务地址

服务地址:https://openapi.starcart.cn/pro/v1,支持 https,以 post 或 get 方式进行请求,返回结果为 json 数据格式。

# img 请求返回值

请求返回值为一个 json 对象,格式如下:

{
    "code": xxx,
    "result": [{xxxx}],
    "msg": "xxx"
}
1
2
3
4
5
名称 描述
code 状态码 1000,调用成功,调用结果符合预期。 非1000,调用失败,调用结果不符合预期。
result 返回数据 当code为1000时,result 不为空,是调用结果的 json 格式数据。 当 code 不为1000时,则 result 为 null。
msg 状态信息描述 对调用结果 code 的文字说明。

# img 状态码

code msg 说明
1003 missing param 缺失参数
1004 invalid param 无效参数

# img 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

• 返回错误结果示例:

{
    "code": 1004,
    "msg": "invalid param"
}				
1
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

• 返回错误结果示例:

{
    "code": 1004,
    "msg": "invalid param"
}				
1
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
网站地图