激活码发码业务

简介

业务介绍

支持TOB业务合作方发放爱奇艺会员激活码

接口定义

适用场景

与合作方洽谈好合作后，在对外合作系统中进行相关的配置，合作方通过请求激活码发送接口，获取激活码。
接口可支持发短信和不发短信两种情况：
（1）发短信：通过请求获取的激活码，直接发送到用户的手机上
（2）不发短信：通过请求获取的激活码返回给请求方，由请求方再去进行进一步处理

接口域名

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

URL

/partner/card/cardSend.action

请求方式

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

请求参数

变量名	类型	是否必须	说明
partnerNo	String	是	合作方编码，由爱奇艺提供，每个合作方有唯一的编号
productCode	String	是	合作方产品编码，由爱奇艺提供，同一个合作方的产品编码必须唯一
partnerOrderCode	String	是	合作方侧订单号
productAmount	int	是	数量，需要短信发送的，单次请求数量不大于10；不需要短信发送的，单次请求数量不大于100
mobile	String	否	合作方需要将激活码直接发送给用户时，手机号必须传；否则，不用传
subscribeTime	String	是	订购时间，用户在合作方订购的时间，格式：2016-10-29 20:06:58
sign	String	是	md5签名，具体加密规则见MD5加密描述
version	String	否	接口版本号，如version=1.0 当version>=1.0时，对于不发短信的情况，重复订单请求会返回激活码信息

返回参数

说明： 发短信的场景，激活码和有效期会以短信发送给用户，合作方请求接口只会返回code和msg；
不发短信的场景，会将激活码相关信息返回给合作方

变量名	名称	数据类型	说明
code	状态编码	String	A00000，成功 Q00301，参数错误 Q00303，不存在的合作方产品 Q00304，不存在的合作方 Q00305，不存在的爱奇艺产品 Q00306，重复订单 Q00307，验签失败 Q00308，激活码获取失败，请重试 Q00309，合作方配置有误 Q00310，没有配置批次号 Q00311，没有配置短信模板 Q00332，系统错误
msg	结果信息	String	code字段对应的描述文字
data.cardInfos	激活码信息	Array	当不需要通过短信发送给用户激活码时，该字段会携带激活码信息返回给请求方

返回示例

{
    "code": "A00000",
    "msg": "处理成功",
    "data": {
        "cardInfos": [
            {
                "code": "B5D8-3E8C-A6DE-3268",     // 激活码
                "endTime": "2017-11-24 00:00:00"     // 过期时间
            },
            {
                "code": "C5D8-9EIC-A6FE-3268",
                "endTime": "2017-11-24 00:00:00"
            }
        ]
    }
}

返回码说明

错误码	说明	备注
A00000	成功
Q00301	参数错误
Q00307	签名错误
Q00332	系统错误
Q00409	订单不存在

附录

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

常见问题

签名错误

历史原因激活码直充和查询接口签名规则不一样，但秘钥是同一个，请仔细阅读每个接口的签名规则。

激活码直充下单未返回成功如何处理

需要合作方对原订单号再次发起同步请求，重试的间隔时间可以逐步扩大（例如最多重试5次，间隔时间依次为1s，5s，30s，1m，3m），直至订单最终同步成功；如果重试多次后，订单同步依然失败，就需要联系爱奇艺侧技术同学排查具体失败的原因。

激活码直充返回Q00408错误码

激活码直充返回Q00408(激活码已绑定其他账号,详情调用查询接口)错误，原因是激活码会对首次充值的用户进行12小时的绑定，这期间会用该激活码给首次充值用户不断重试，给用户如果充值失败12小时后才可给其他用户使用。

场景举例： 手机号A消费激活码X，由于我们内部服务异常返回了非A00000；合作方又用手机号B来消费激活码X，如果在A提交的12小时内，就会收到Q00408；若12小时后爱奇艺这边重试失败的话，就会释放激活码X，合作方就可以把激活码X继续出售给手机号B等。若在12小时我们内部的重试周期内，你们用手机号B来消费激活码X看到408，可以选择给B退款

在线测试

参数	值	备注
partnerNo	test_card_send
productCode	111

所需密钥：

参数	值
MD5密钥	b0ee3c7f62760330

点击此处进行接口调试

在线调试