# OTT取消自动续费接口
# 简介
# 业务介绍
支持合作方取消自动续费状态,通知爱奇艺变更自动续费状态
# 接口定义
# 应用场景
取消自动续费时调用该接口通知爱奇艺更改自动续费状态
# 接口域名
环境 | 域名 |
---|---|
生产 | openapi.vip.iqiyi.com |
测试 | test-openapi.vip.iqiyi.com |
# URL
/renew/cancel.action
# 请求方式
参数 | 说明 |
---|---|
Method | GET/POST |
Content-Type | application/x-www-form-urlencoded |
# 请求参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
partner_no | String | 是 | 合作方编号,又称商户号 |
sign | String | 是 | md5签名,加密规则见MD5加密描述 |
open_id | String | 是 | 合作方用户身份标识 |
reason | String | 是 | 取消原因类型,如下: 1.用户主动取消 2.扣费失败 |
# 返回参数
参数 | 类型 | 说明 |
---|---|---|
code | String | 状态码 |
msg | String | 状态码说明 |
# 返回示例
{
"code": "Q00301",
"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 | |
reason | 1 2 | 1: 用户自动取消 2: 扣费失败 |
所需密钥:
参数 | 值 |
---|---|
MD5密钥 | 123456789 |
点击此处进行接口调试