点播券可用数量查询接口

简介

业务介绍

支持合作方查询点播券可用数量

接口定义

应用场景

通过此接口查询点播券可用的数量。

接口域名

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

URL

/vod/coupon/getVodCount.action

请求方式

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

请求参数

变量名	名称	是否必须	说明
messageId	消息ID	是	标识一次请求的messageId, 规则如下:长度大于16，不能重复,格式为appName_UUID。
version	版本	是	默认值1.0
area	地区	是	TW:台湾, CN:大陆(默认)
partnerCode	合作方标识	是	合作方标识，用于查询合作配置数据和用户信息
is_login	是否是免登陆	否	给小米盒子用
dev_mac	mac地址	否	给小米盒子用
cp_data	cp_data	否	给小米盒子用
user_id	用户标识	是	不是小米盒子，必传，用户标识
sign	签名	是	合作方签名，加密规则见MD5加密描述
callback	JSONP参数	否	使用jsonp的格式返回

返回参数

字段说明

字段名	类型	说明
code	String	A00000：成功，Q00301：参数错误，Q00332：系统错误
msg	String	返回码说明
result.code	String	A00000：成功，Q00301：参数错误，Q00332：系统错误
result.message	String	结果描述
result.data.sendGiftSize	Integer	可用点播券总数

返回示例

返回值格式

{
    "code": "A00000",
    "msg": "成功",
    "result": {
         "code": "A00000",
         "message": "成功",
         "data": {
               " sendGiftSize" : 3
          }
    }
}

返回码说明

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

常见问题

接口功能是什么，内容逻辑是什么？
​ 接口是为对外合作使用的代理接口，主要是业务逻辑为，由使用方传入openId，由代理方根据openId获取爱奇艺的账户uid,如果用户有点播券，消费一张用户点播券，然后给用户发放权益，用于观看内容

权益有效时间是多少 ？
​ 爱奇艺一张点播券时间为48小时（2天），从消费完成时，开始计时。过期后，需要再次消费一张点播券。

如果用户没有点播券，会返回什么 ？
​ result.code ＝ Q00401

如何判断用户消费点播券成功 ？
​ result.code = A00001 && data.vodCoupon != null, 此时 hasUsedVodCoupon = false 表示消费了用户一张点播券， hasUsedVodCoupon = true 表示用户已经有观看的权益，不需要再消费一张点播券

如果调用成功之后，重试一次会怎样？
​ 正常情况下，应该只有首次调用，但是可能存在重试的情况，如果消费后再调用或是用户已经有权益的情况下调用用券接口， 不会再消费用户的点播券，同时 hasUsedVodCoupon＝true, 建议首次调用失败可以重试一次。

在线测试

参数	值	备注
partnerCode	T_Coupon_Pepsi
version	1.0
area	TW CN	TW:台湾 CN:大陆(默认)

所需密钥：

参数	值
MD5密钥	1234567890

点击此处进行接口调试

在线调试