功能介绍
此接口用于查询用户权益。
场景描述
支持用户查询名下权益。
接口原型
承载协议 | HTTPS POST |
|---|---|
接口方向 | 小艺开放平台服务器 -> 开发者服务器 |
接口URL | interfaceUrl(开发者自定义) |
数据格式 | 请求消息:Content-Type: application/json;charset=UTF-8 响应消息:Content-Type: application/json;charset=UTF-8 |
鉴权方式
AK/SK:
使用预共享密钥认证方式。
OAuth:
使用OAuth2.0流程认证,当前仅支持Client模式,OAuth2.0协议规范,可访问OAuth2.0官方网站。
鉴权方式可参考创建云插件方式进行鉴权。
请求参数
Request Header
参数 | 参数类型 | M/O | 说明 |
|---|---|---|---|
Content-Type | String | M | 取值为:application/json;charset=UTF-8 |
Authorization | String | M | 基于OAuth2.0的认证方式,应用级AT, bearer类型 |
accessKey | String | M | 认证信息配置中Access key的值 |
sign | String | M | 参数签名=Base64(HMAC-SHA256(secretKey,ts))。其中secretKey为认证信息配置中Secret key的值 |
ts | String | M | 时间戳,用于加密和缓存穿透。格式为:当前计算机时间和GMT时间(格林威治时间)1970年1月1号0时0分0秒所差的毫秒数。例如:2018/1/1 08:00:00.000的时间戳为"1514764800000" |
Request Body
参数 | 参数类型 | M/O | 说明 |
|---|---|---|---|
userIdType | String | M | 用户账号类型,开发者自定义:CP_USER_ID |
userId | String | M | 用户id |
purchaseTest | Boolean | O | 真机测试场景触发时该字段为True,缺省False |
deviceType | Integer | M | 设备类型,默认手机:0 [手机:0,平板:2,手表:4,车机:5,PC:11] |
响应参数
Response Header
参数 | 参数类型 | M/O | 说明 |
|---|---|---|---|
Content-Type | String | M | 取值为:application/json;charset=UTF-8 |
Response Body
参数 | 参数类型 | M/O | 说明 |
|---|---|---|---|
privilegeList | List<AgentPurchasePrivilege> | M | 用户权益列表 |
AgentPurchasePrivilege
参数 | 参数类型 | M/O | 说明 |
|---|---|---|---|
privilegeName | String | M | 权益名称 |
privilegeId | String | M | 权益id,唯一标识 |
privilegeStatus | String | M | 权益状态, Active 生效、Inactive 失效 |
expireTime | String | M | 权益失效时间,格式:yyyyMMddHHmmssSSS |
privilegeDetail | List<String> | M | 权益详细信息,该字段用于展示权益详情 |