# OTT查询赠送黄金的历史订单接口
# 简介
# 业务介绍
支持以合作方、用户维度查询所有领取的爱奇艺黄金会员订单记录，注：此接口只能查到两年内的数据，两年前的历史数据爱奇艺侧已做了历史归档。
# 接口定义
# 应用场景
调用该接口查询合作方已赠送的黄金会员，可展示在交易记录中
# 接口域名
| 环境 | 域名 |
|---|---|
| 生产 | openapi.vip.iqiyi.com |
| 测试 | test-openapi.vip.iqiyi.com |
# URL
/act/presentHistory.action
# 请求方式
| 参数 | 说明 |
|---|---|
| Method | GET/POST |
| Content-Type | application/x-www-form-urlencoded |
# 请求参数
| 变量名 | 类型 | 是否必需 | 说明 |
|---|---|---|---|
| partner_no | String | 是 | 合作方固定编码 |
| sign | String | 是 | md5签名，加密规则见MD5加密描述 |
| partner_uid | String | 3选1 | 用户在合作方的标识，即openid |
| take_mobile | String | 3选1 | 用户领取黄金时填写的手机号 |
| original_order | String | 3选1 | 赠送黄金的原始订单号，即合作方的奇异果订单号 |
# 返回参数
| 变量名 | 名称 | 数据类型 | 说明 |
|---|---|---|---|
| code | 状态编码 | String | 返回码，该接口会返回错误码Q00301（参数错误），Q00307（签名错误），Q00345（没有数据） |
| message | 结果信息 | String | 返回码释义 |
| data | 数据节点 | String |
# 返回示例
{
"code": "A00000", #返回码，该接口会返回错误码Q00301（参数错误），Q00307（签名错误），Q00345（没有数据）
"message": "处理成功", #返回码释义
"data": {
"history": [ #数组形式
{
"amount": 30, #赠送黄金会员天数，单位：天
"originalOrder": "mytest201608121154", #原始订单号，即奇异果订单号
"partnerUid": "8589151_3c4d5de10a503d8a60994a8e21208b75", #奇异果订单里的合作方用户标识，即openid
"status": 1, #状态，取值：0-已成功领取，1-待领取，2-领取失败，3-已领取的退单，4-未领取的退单
"takeDeadline": "2016-09-11 11:55:10", #赠送订单领取有效截止时间，一般为30天有效期
"takeMobile": "", #领取的手机号，中间4位已隐藏
"takeTime": "", #领取的时间，格式yyyy-MM-dd HH:mm:ss，与takeDeadline时间格式一致
"takeUid": 4596286044 #领取手机号当时绑定的爱奇艺uid
},
{
"amount": 30,
"originalOrder": "201805100725401x",
"partnerUid": "8589151_3c4d5de10a503d8a60994a8e21208b75",
"status": 0,
"takeDeadline": "2016-09-11 14:08:55",
"takeMobile": "185****7846",
"takeTime": "2016-08-17 22:30:25",
"takeUid": 0
}
]
}
}
# 返回码定义
| 返回码code | 描述 | 备注 |
|---|---|---|
| A00000 | 成功 | |
| Q00301 | 参数错误（如合作方编号为空，合作方用户为空等） | |
| Q00307 | 签名错误 | |
| Q00332 | 系统错误 | |
| Q00711 | 调用规则引擎失败 | |
| Q00712 | 合作方没有有效的营销策略 | |
| Q00713 | 合作方用户没有可用的优惠资格 |
# 附录
# MD5加密描述
采用MD5计算签名，MD5密钥由爱奇艺提供，具体计算方法如下：
1、 假设共有三个参数 a=3、b=2、c=1；
2、 按参数名的字母正序排列，再用“&”连接后得到串A，即为“a=3&b=2&c=1”；
3、 将MD5密钥拼接到串A后面，假设MD5密钥为“qwer”，则拼接后为“a=3&b=2&c=1qwer”；
4、 计算拼接串的MD5即为最终签名值，注意使用UTF-8编码计算,MD5后的签名最后都转成小写。
举例：
参数：a=3、b=2、c=1；
MD5密钥：qwer
最终签名串：f80118ff523f25eda67cb799bdc9c52d
# JAVA版本示例代码如下：
public class Test{
/**
* MD5签名测试类
*
*/
private static final char[] DIGITS = {'0', '1', '2', '3', '4', '5', '6',
'7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
public static void main(String[] args) {
TreeMap<String, Object> paramMap = new TreeMap<>();
paramMap.put("a", "3");
paramMap.put("b", "2");
paramMap.put("c", "1");
String md5key = "qwer";
String targetParam = Joiner.on("&").withKeyValueSeparator("=")
.useForNull("").join(paramMap);
// MD5签名工具类,可以自己实现, MD5实现参照
String targetSign = EncodeUtils.MD5(targetParam + md5key, "UTF-8");
System.out.println("targetSign: " + targetSign);
}
}
# 加密工具类
# MD5加密
import com.google.common.base.Joiner;
import org.apache.commons.lang.StringUtils;
import org.junit.Test;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;
import java.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
public class EncodeUtils{
public static String MD5(String text, String charset) {
MessageDigest msgDigest = null;
try {
msgDigest = MessageDigest.getInstance("MD5");
} catch (NoSuchAlgorithmException e) {
throw new IllegalStateException("System doesn't support MD5 algorithm.");
}
try {
msgDigest.update(text.getBytes(charset)); //注意改接口是按照指定编码形式签名
} catch (UnsupportedEncodingException e) {
throw new IllegalStateException("System doesn't support your EncodingException.");
}
byte[] bytes = msgDigest.digest();
String md5Str = new String(encodeHex(bytes));
return md5Str;
}
public static char[] encodeHex(byte[] data) {
int l = data.length;
char[] out = new char[l << 1];
// two characters form the hex value.
for (int i = 0, j = 0; i < l; i++) {
out[j++] = DIGITS[(0xF0 & data[i]) >>> 4];
out[j++] = DIGITS[0x0F & data[i]];
}
return out;
}
}
# 在线测试
| 参数 | 值 | 备注 |
|---|---|---|
| partner_no | ott_test |
所需密钥：
| 参数 | 值 |
|---|---|
| MD5密钥 | 123456789 |
点击此处进行接口调试