会员对外文档平台 会员对外文档平台
登录
接口
介绍
  • TOB直充接口

  • TOB激活码直充接口

  • OTT直充接口

  • OTT自动续费接口

  • OTT激活码直充接口

  • 通用接口

  • 内容点播接口

  • 卡券类接口

  • 用户信息接口

    • 观影时长开始记录接口
    • 查询用户会员等级接口
    • 权益查询接口
    • 观影时长查询接口
    • 用户信息解密接口
  • 会员福利接口

  • 合作方客户FV管理

# 权益查询接口

# 简介

# 业务介绍

支持合作方查询当前用户会员身份,会员权益到期时间

# 接口定义

# 应用场景

合作方可以通过该接口获取用户的权益到期时间。

# 接口域名

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

# URL

/vip/info.action

# 请求方式

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

# 请求参数

名称 类型 必填 说明
partner String 是 合作方编码
user_id String 是 支持手机号、邮箱、32或64位的OTT合作方账号openid、爱奇艺的uid或authcookie
user_type String 是 用户账号类型,取值如下:
账号类型 值
SDK厂商openId ott
手机号 mobile
邮箱账号 email
爱奇艺cookie cookie
vip_type String 是 会员类型,取值如下:
会员类型身份 值
黄金VIP会员(大陆主站会员) gold
爱奇艺白金会员(大陆主站会员) pt
爱奇艺星钻会员(大陆主站会员) diamond
TV基础会员 tv_basic
电视专享会员 tv_pri_vip
奇异果会员 tv
奇异果星钻会员 tv_diamond
点播 vod
点播券 coupon
sign String 是 合作方签名,加密规则见MD5加密描述
content_id Number 否 当vip_type=vod(点播)时,返回该内容的会员有效期

# 返回参数

字段名 类型 说明
code String 返回码,参考附录
msg String 返回码说明
data String 返回数据

##返回示例 (注意不同类型会员返回的json格式不同):

# 点播

{
    "code": "A00000",
    "data": {
        "deadline": {
            "t": 1402551280000,//会员过期时间戳,毫秒
            "date": "2014年06月12日"//过期日期,yyyy年MM月dd日
        }
    },
    "msg": "处理成功"
}

# 点播券

{
    "code": "A00000",
    "data": [
        {
            "contentId": 1214805100,//爱奇艺内容id(奇谱id)
            "deadline": 1543322338000,//点播券有效时间戳,毫秒
            "updateTime": 1541406608000,//更新时间戳,毫秒
            "useStatus": 1,//点播券状态:0-未使用,1-已使用
            "useTime": 1541406608000,//使用时间戳,毫秒
            "userId": "1571011967",//爱奇艺uid
            "vodDeadline": 1541579408000//点播内容有效时间戳,毫秒,一般为useTime+48h
        }
    ],
    "msg": "处理成功"
}

# 其他会员

{
    "code": "A00000",
    "data": {
        "t": 1556368738000, //会员过期时间戳,毫秒
        "date": "2019年04月27日"//过期日期,yyyy年MM月dd日
    },
    "msg": "成功"
}

# 返回码定义

返回码code 描述
A00000 处理成功
Q00301 参数错误(如user_id不能为空,vip_type非法等)
Q00307 签名错误
Q00332 系统错误
Q00353 查询点播劵信息失败
Q00304 账号转换失败
Q00352 没有会员权益
Q00413 查询会员信息失败

# 附录

# 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 toB_common_test
vip_type gold
pt
diamond
tv_basic
tv_pri_vip
tv
tv_diamond
vod
coupon
黄金VIP会员
爱奇艺白金会员
爱奇艺星钻会员
TV基础会员
电视专享会员
奇异果会员
奇异果星钻会员
点播
点播券
user_type ott
mobile
email
uid
cookie
SDK厂商openId ott
手机号 mobile
邮箱账号 email
爱奇艺账号 uid
爱奇艺cookie cookie

所需密钥:

参数 值
MD5密钥 b0ee3c7f62760330
点击此处进行接口调试
在线调试

← 查询用户会员等级接口 观影时长查询接口 →