# 星钻升级直充接口

# 简介

# 业务介绍

支持合作方奇异果黄金升级奇异果星钻会员，支持升级30天月卡、90天季卡、365天年卡和全部天数四个套餐。

# 接口定义

# 应用场景

合作方订单完成后调用本接口，通知爱奇艺为用户升级会员权益。

# 接口域名

环境	域名
生产	openapi.vip.iqiyi.com
测试	test-openapi.vip.iqiyi.com

# URL

/vipUpdate/subscribe

# 请求方式

参数	说明
Method	GET/POST
Content-Type	application/x-www-form-urlencoded

# 请求参数

变量名	名称	是否必须	说明
partnerNo	合作方编码	是	合作方的唯一标识，由爱奇艺提供
sign	签名串	是	MD5签名，签名方法见MD5加密描述
orderNo	订单号	是	合作方的订单号，字符串或数字或两者组合，必须能唯一标识每个订单，长度至少16位建议格式：partnerNo_16位随机串码,例如iqiyi_abcdefgh12345678
item	产品编码	是	产品编码，由爱奇艺与合作方约定注意：单片点播编码类似于“single”，非单点产品编码不能与之相同
contentId	奇谱内容编号	当item=single时必传	对应爱奇艺点播内容的奇谱id，只有当item=single时，此字段才有意义
amount	数量	是	购买产品数量
sum	金额 (整数)	是	订单总金额（=合作方侧商品售卖单价*amount），单位为“分”，注意转换
mobile	用户手机号	3选1	手机号，未注册的爱奇艺会自动注册，并下发短信通知用户账号信息
encryptedMobile	加密的手机号	3选1	加密格式的手机号（其他同上），采用RSA加密，密钥由爱奇艺提供
partnerUserId	合作方用户id	3选1	可选，如果同时传入mobile/ encryptedMobile字段，优先取此字段。对于无法传手机号的合作方，可传此字段。
areaCode	手机号区号	否	不传默认为大陆手机区号86，台湾手机区号传886
behavior	用户购买行为	否	爱奇艺侧用于统计用户的购买行为，并不影响订单的权益开通，取值：1-用户首购，2-用户续费，3-系统代为续费
version	接口版本号	否	当version≥2.0时，返回结果中才会包含startTime字段

# 返回参数

字段名	类型	说明
code	String	返回码，参考附录
msg	String	返回码说明
startTime	String	会员开始时间，格式：yyyy-MM-dd HH:mm:ss
deadline	String	会员结束时间，格式：yyyy-MM-dd HH:mm:ss

# 返回示例

返回JSON

{
  "code": "A00000",
  "msg": "成功",
  "data": {
      "startTime": "2016-11-11 12:00:00",
      "deadline": "2016-11-11 12:00:00"
    }
}

# 返回码定义

返回码code	描述	备注
A00000	请求成功	无
Q00301	参数错误（如合作方编号为空，订单号非法等）	无
Q00304	用户账号校验失败，合作方传过来的手机号等，我们需要去内部的账号系统校验合法性，如果在校验过程交互超时或校验失败，就会返回此错误码	建议重试
Q00305	用户不是新用户（调用新用户产品时才会返回）	无
Q00307	签名错误	无
Q00308	请求超时	建议重试
Q00332	系统错误	无
Q00406	调交易下单失败，无法重试	无
Q00407	交易下单失败_系统在异步重试_请稍后重新下单	建议重试或者等异步通知
Q00408	订单已存在	无
Q00409	订单不存在	无
Q00411	非有效的价格	无
Q00412	超过产品单次购买最大数量限制	无
Q00413	查询会员信息失败	建议重试
Q00414	封停用户	无
Q00607	未签约自动续费	无
Q00608	请求自动续费接口错误	建议重试
Q00613	用户未购买过老版本学生会员套餐（仅老版本学生会员未购买过老版本学生会员的用户不再支持购买老版本的学生会员）	无
Q00614	用户已经是黄金或星钻会员, 无法购买学生会员套餐	无
Q00615	用户学生会员套餐已达购买次数上限（仅学生会员学生会员权益累计购买时长不能超过24个月）	无
331	查询会员可升级天数失败	建议重试
332	用户不符合升级条件	无

# 重试机制

如果在同步订单过程中，遇到接口超时、或是爱奇艺侧返回了“用户账号校验失败”等错误码，需要合作方对原订单号再次发起同步请求，重试的间隔时间可以逐步扩大（例如最多重试5次，间隔时间依次为1s，5s，30s，1m，3m），直至订单最终同步成功；如果重试多次后，订单同步依然失败，我方又未回调，就需要联系爱奇艺侧技术同学排查具体失败的原因。

目前需要重试的错误码有：Q00304（账号转换失败），Q00308（请求超时），Q00407（交易下单失败），Q00413（查询会员信息失败），Q00608（请求自动续费接口错误），331（查询会员可升级天数失败）

# 附录

# 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;
    }
}

# 常见问题

# 签名错误

请仔细阅读按签名规则和示例代码，需要注意：参数值为null的，key也会参与计算签名，所以最好传参就去掉值为null的key。MD5后的签名最后都转成小写 MD5实现参照 (opens new window)

# 下单未返回成功如何处理

可以重试发起下单、或接入回调接口等待我方成功后回调（如果接入了），我方重试间隔（回调时间点）如下：
{ "5s", "10s", "1m", "5m", "10m", "30m", "1h", "2h", "12h" }
即回调最晚时间是在12h后，如果下单后12h仍未回调，请联系我方人工处理。

# 在线测试

参数	值	备注
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）

所需密钥：

参数	值
MD5密钥	123456789

点击此处进行接口调试