卡券（代金券）发放接口

简介

业务介绍

支持为合作方用户发放代金券，代金券批次、数量、金额维护在支付卡券管理系统中

接口定义

适用场景

合作方需要给用户发放卡券（代金券），可以使用此接口，单次请求只能下发一张。合作方编码、密钥、卡券编码信息维护在对外合作系统里，而代金券的批次、数量维护在支付的卡券管理系统。

接口域名

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

URL

/coupon/send.action

请求方式

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

请求参数

名称	类型	必填	说明
order_code	String	是	区分不同请求的标识，保证接口的幂等性，支持重试机制
req_time	String	是	下发时间，unix时间戳（秒）
partner	String	是	合作方编码，由爱奇艺提供
product	String	是	卡券产品编码，如黄金会员月卡5元代金券编码gold_month_coupon_5，由爱奇艺提供
account	String	是	合作方用户账号，目前仅支持手机号，未注册爱奇艺的手机号我们会为其自动开通
sign	String	是	md5签名，签名规则见MD5加密描述
msg_id	String	是	每次请求的唯一标识（建议即使在重试时也要保证此参数不同），如遇接口问题可直接提供此标识，便于我们快速定位问题
version	String	是	接口版本号，默认1.0

返回参数

参数	类型(长度)	说明
sub_type	String(2)	卡劵子类别 类型 描述 1 代金券 2 限价券 3 激活码 4 通用卷
status	String(2)	卡券状态 状态值 状态描述 0 未激活 1 可使用 2 冻结 3 已使用 4 锁定 5 已销毁
start_time	String(19)	有效期开始日期，格式:yyyy-MM-dd HH:mm:ss
end_time	String(19)	有效期结束日期，格式:yyyy-MM-dd HH:mm:ss
coupon_code	String(20)	卡券码
batch_no	String(20)	卡券批次号
amount	String(20)	面额，单位为分
product	String(32)	产品描述
settlement	String(32)	结算价，单位分

返回示例

json格式

{
    "msg_id": "3250d8d6-f34a-454c-b347-b58643e075ba",
    "code": "A00000",
    "msg": "处理成功",
    "data": {
        "amount": "500",
        "product": "黄金套餐月卡及以上，且订单金额≥19.8元时使用，IOS端目前需在网页下单使用。",
        "status": "1",
        "end_time": "2018-11-10 23:59:59",
        "coupon_code": "2011-2B21-3D1E-B5F5",
        "sub_type": "1",
        "start_time": "2018-05-14 11:18:03",
        "settlement": "0",
        "batch_no": "2018050911452734205"
    }
}

返回码说明

code	msg
A00000	处理成功，其他code码均为处理失败
Q00301	参数错误
Q00304	账号校验失败，有可能是网络问题，建议重试
Q00801	代金券获取失败

附录

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	T_Coupon_Pepsi
product	gold_month_coupon_5 gold_season_coupon_10 gold_year_coupon_50	gold_month_coupon_5-黄金会员月卡5元代金券 gold_season_coupon_10-黄金会员季卡10元代金券 gold_year_coupon_50-黄金会员年卡50元代金券
version	1.0

所需密钥：

参数	值
MD5密钥	1234567890

点击此处进行接口调试

在线调试