注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > YunOS开放平台

API接口说明

更新时间:2017/07/31 访问次数:36134

加密签名模式

YUNOS传递的入参只有2个,分别是k和data。

k是随机秘钥的密文,data是加密的入参数据。

签名模式:YUNOS传递的入参只有1个,参数key是data。

2.1           ISV入参data中参数列表

 

名称

类型

是否必填

示例值

默认值

描述

traceId

String

 

默认有

每次调用的唯一编号

sign

String

 

默认有

签名MD5

sysTime

Long

1430123794266

默认有

分页查询用,客户端请求接口的时间戳。距离1970-01-01 00:00:00的毫秒数

did

String

61C6BCB9B88BE79751E4C86679D8B355

默认有

混淆后设备唯一号

openId

String

默认不传

 

用户OpenId

geo

String

默认不传

 

用户当前经纬度

val

String

默认不传

默认有

事件值,配置说明点击这里。请保证val为空时有精品数据返回,详见轻服务用户场景

geo=经度*维度*海拔*获取位置时间(39.998349415*116.2678606653*1200.88*long时间)

海拔没有的传0.0。时间为毫秒。

2.2           返回值(参考sdk: com.yunos.datapull.api.response.ApiResponse)

名称

类型

示例值

描述

code

Integer

参考2.3错误码表

错误码

msg

String

如:参数错误,tUid必填

错误描述

traceId

String

 

请求参数里的traceId,需要将请求的traceId带回来,
方便问题跟踪

jsonModel

String

参考jsonModel

数据内容,JSON格式字符串,

内容详细字段

sign

String

 

内容签名

 

注意:返回json数据的构造说明

//1,首先将具体业务的数据转换为json(其中list是List<DataModel> 类型,一次返回多条数据)。
String jsonModel = JacksonUtil.toJson(list);
 
//2,然后构造返回结果对象,将业务数据json设置到返回结果对象中
ApiResponse result = new ApiResponse();
result.setCode(200);
result.setMsg("success");
result.setJsonModel(jsonModel);
//内容签名,MD5(jsonModel+'\0\ + 签名key)
result.setSign(YunosDataUtil.getResponseDataSign(dataListJson, SIGN_KEY));
 
//3,最后将返回结果对象转换成json字符串返回给YUNOS服务器。具体示例代码参考: 明文密文
String jsonResult = JacksonUtil.toJson(result);

完整json返回值范例:

{
"traceId": "a5LitlBGeoMAcIyPBQBQBwOg51k6GSiq", //请求的traceId带回 "code": 200, "msg": "success", "jsonModel": "[{\"id\":\"id_test\",\"title\":\"title_1\"}]"//数据部分 }

 

2.3           错误码

名称

错误码

描述

成功

200

OK

参数错误

400

参数错误

签名验证失败

450

签名验证不通过

IOException

461

IOException

系统异常

500

系统异常

 

FAQ

关于此文档暂时还没有FAQ
返回
顶部