# OTT取消长订单自动续费接口(自主代扣模式)
# 简介
# 业务介绍
合作方存在两种自动续费模式
1:合作方每月自行调用自动续费接口下单,通知爱奇艺为用户续费
2:合作方第一次开通自动续费,后续由爱奇艺自主代扣为用户续费,合作方不再调自动续费接口下单。
# 接口定义
# 应用场景
合作方通过取消自动续费接口,取消自动续费并回收权益。
# 接口域名
环境 | 域名 |
---|---|
生产 | openapi.vip.iqiyi.com |
测试 | test-openapi.vip.iqiyi.com |
# URL
/partner/renew/cancel
# 请求方式
参数 | 说明 |
---|---|
Method | GET/POST |
Content-Type | application/x-www-form-urlencoded |
# 请求参数
变量名 | 名称 | 是否必填 | 类型 | 说明 |
---|---|---|---|---|
partnerNo | 合作方编码 | 是 | String | 合作方编码 |
partnerUserId | 合作方用户id | 是 | String | 1)用户32或64位账号,多用于TV厂商 2)ToB合作方多是手机号 和调用充值的参数合作方userId为同一值 |
reason | 取消原因 | 是 | String(256) | |
item | 合作方产品code | 是 | String | 合作方产品code 由爱奇艺方提供 |
retrieve | 是否回收权益 | 否 | Integer | 0-否,1-是,不传默认0 |
sign | 签名串 | 是 | String | MD5签名,签名方法见MD5加密描述 |
uid | 爱奇艺用户账号 | 否 | Long | 如果有可以填入 |
# 返回参数
字段名 | 类型 | 说明 |
---|---|---|
code | String | 返回码: A00000请求成功, Q00301参数错误, Q00332系统错误, Q00307 签名错误 |
msg | String | 返回码说明 |
# 返回示例
{
"code": "A00000",
"msg": "成功"
}
返回的Content-Type要设置为: application/json;charset=UTF-8
# 返回码定义
返回码code | 描述 | 备注 |
---|---|---|
200 | 成功 | |
301 | 参数错误 | |
302 | RSA解密错误 | |
303 | RSA签名错误 | |
306 | 系统错误 | |
328 | 订单不存在 |
# 附录
# 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 | |
item | 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) |
reason | 1 2 | 1: 用户自动取消 2: 扣费失败 |
所需密钥:
参数 | 值 |
---|---|
MD5密钥 | 123456789 |
点击此处进行接口调试