# 合作方获取用户优惠资格接口
# 简介
# 业务介绍
合作方通过本文档的接口根据传入的用户id判断该用户是否具有优惠资格,如果有,返回优惠信息。
# 接口定义
# 应用场景
查看某合作方下某用户,是否具有某产品的优惠资格,如果有返回唯一编码。优惠资格对应配置的优惠价
# 接口域名
环境 | 域名 |
---|---|
生产 | openapi.vip.iqiyi.com |
测试 | test-openapi.vip.iqiyi.com |
# URL
/partner/discount/getDiscountInfo
# 请求方式
参数 | 说明 |
---|---|
Method | GET/POST |
Content-Type | application/x-www-form-urlencoded |
# 请求参数
变量名 | 名称 | 是否必须 | 说明 |
---|---|---|---|
partnerNo | 合作方编码 | 是 | String型,合作方的唯一标识 |
sign | 签名串 | 是 | String型,MD5签名,签名方法见MD5加密描述 |
partnerUserId | 合作方用户Id | 是 | String型 |
tag | 标签信息json | 否 | String型,例如:{"tagNewUser":"Price",#标签1及对应的值"tagCityLevel":"highPrice" #标签2及对应的值 } |
# 返回参数
变量名 | 名称 | 数据类型 | 说明 |
---|---|---|---|
code | 状态编码 | String | 返回码,该接口会返回错误码Q00301(参数错误),Q00307(签名错误),Q00345(没有数据) |
msg | 结果信息 | String | 返回码释义 |
data | 数据节点 | String |
# 返回示例
爱奇艺在收到合作方的查询优惠资格的请求后,应答合作方,内容为Json String 样例如下:
{
"code": "A00000", # A00000代表成功,其他为错误码见附录(String型)
"msg": "处理成功", #成功填”处理成功”,其他情况填写具体的错误信息(String型)
"data": [{
"payCode": "discounta295c67425fe002b", #优惠资格唯一标识,直充时刻用(String)
"validStartTime": 1562221837000, #优惠资格有效开始时间 时间戳(long)
"validEndTime": 1571034637000, #优惠资格有效结束时间 时间戳(long)
"parnterProduct": "skyworth_renew", #合作方产品编码(String)
"discountPrice": 400 #合作方产品优惠价格 单位:分(int)
"marketDesc": "营销文案test" #营销文案
}]
}
注:可能有多个优惠资格信息 所以data是个list
# 返回码定义
返回码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;
}
}
# 在线测试
参数 | 值 | 备注 |
---|---|---|
partnerNo | ott_test |
所需密钥:
参数 | 值 |
---|---|
MD5密钥 | 123456789 |
点击此处进行接口调试