# OTT开通自动续费接口
# 简介
# 业务介绍
支持合作方开通自动续费,普通版支持固定价格开通自动续费,活动版支持首月低价开通自动续费
# 接口定义
# 应用场景
调用该接口开通自动续费
# 接口域名
环境 | 域名 |
---|---|
生产 | openapi.vip.iqiyi.com |
测试 | test-openapi.vip.iqiyi.com |
# URL
/renew/order.action
# 请求方式
参数 | 说明 |
---|---|
Method | GET/POST |
Content-Type | application/x-www-form-urlencoded |
# 请求参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
reqId | String | 是 | 随机生成即可,作为每次请求的唯一标识 |
version | Integer | 是 | 版本号,默认version=1 |
partner_no | String | 是 | 合作方编号,又称商户号 |
open_id | String | 是 | 合作方用户身份标识 |
order_code | String | 是 | 合作方订单号 |
order_fee | Integer | 是 | 订单价格,单位:分 |
product_no | String | 是 | 产品编号 |
product_amount | Integer | 是 | 产品数量,必须为1; |
pay_time | String | 是 | 订单支付时间,格式:yyyy-MM-dd HH:mm:ss |
device_id | String | 是 | 设备号 |
third_pay_uid | String | 否 | 合作方用户在第三方支付平台开通自动续费的身份标志 |
mobile | String | 否 | 手机号 |
user_ip | String | 否 | 用户端ip |
renew_type | Integer | 是 | 活动开通,renew_type=0 正常开通、续费,renew_type=1 |
auto_renew | Integer | 是 | 用户开通自动续费,auto_renew=0 系统发起续费代扣,auto_renew=1 |
sign | String | 是 | md5签名,加密规则见MD5加密描述 |
extend_params | String | 否 | 标签信息json,例如:{"tagNewUser":"Price",#标签1及对应的值"tagCityLevel":"highPrice" #标签2及对应的值 } |
pay_code | String | 否 | 如有优惠资格需要传,否则不传 |
fc | String | 爱奇艺内部渠道来源信息标识,非爱奇艺售卖渠道无需填写 | |
fr_version | String | 爱奇艺内部渠道收银台标识,非爱奇艺售卖渠道无需填写 |
# 返回参数
参数 | 类型 | 说明 |
---|---|---|
code | String | 状态码 |
msg | String | 状态码说明 |
# 返回示例
{
"code":"Q00601","msg":"用户已参加优惠活动"
}
# 返回码定义
code | message | 备注 |
---|---|---|
A00000 | 成功 | |
Q00301 | 参数错误 | |
Q00307 | 签名错误 | |
Q00332 | 系统错误 | |
Q00347 | 非法的IP | |
Q00601 | 用户已参加优惠活动 | |
Q00602 | 无效的续费用户 | |
Q00603 | 请求已达上限 | |
Q00604 | 非法的续费日期 | |
Q00605 | 尚未配置优惠策略 | |
Q00606 | 重复的续费订单 | |
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 | |
product_no | t_prod_1 t_prod_month t_prod_season t_prod_year single | t_prod_1:奇异果天卡 t_prod_month:奇异果月卡 t_prod_season:奇异果季卡 t_prod_year:奇异果年卡 single:单点产品(cp_content_id=245025400) |
version | 1 | |
renew_type | 1 | 1: 正常开通、续费 |
auto_renew | 0 1 | 0 : 用户开通自动续费 1 :系统自动发起续费代扣 |
所需密钥:
参数 | 值 |
---|---|
MD5密钥 | 123456789 |
点击此处进行接口调试