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

  • TOB激活码直充接口

  • OTT直充接口

    • 订单直充接口
    • 订单状态查询接口
    • 查询赠送黄金的历史订单接口
    • 查询待领取黄金会员信息接口
    • 页面领取黄金会员接口
    • 绑定领取会员手机号接口
    • 后端领取黄金会员接口
    • 小米账号换绑手机号接口
    • 查询领取绑定手机号接口
    • 合作方获取用户优惠资格接口
    • 合作方获取接口产品最低售卖价接口
  • OTT自动续费接口

  • OTT激活码直充接口

  • 通用接口

  • 内容点播接口

  • 卡券类接口

  • 用户信息接口

  • 会员福利接口

  • 合作方客户FV管理

# OTT查询待领取黄金会员信息接口

# 简介

# 业务介绍

支持查询用户有无待领取的黄金会员,若有则引导用户领取会员

# 接口定义

# 应用场景

查询有无待领取爱奇艺黄金会员

# 接口域名

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

# URL

/act/queryGiftVip.action

# 请求方式

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

# 请求参数

参数名 类型 是否必填 说明
sign String 是 MD5加密,加密规则见MD5加密描述
pUid String 是 用户在合作方侧的身份标识,即openid
partner String 是 合作方编号,由爱奇艺配置,并且产品的买赠开关是开启状态

# 返回参数

变量名 名称 数据类型 说明
code 状态编码 String 返回码,该接口会返回错误码Q00301(参数错误),Q00307(签名错误),Q00345(没有数据)
msg 结果信息 String 返回码释义
data 数据节点 String

# 返回示例

{
    "code":"A00000",
    "data": 
    {
        "gift_receive_deadline": 1608863300,
        "gift_receive_time": "30天",
        "gift_receive_url":"http://www.iqiyi.com/getGoldenVip.html?pagetype=1&token=testcFVpZD05MzQ1MDA1M180MTM4MTM3YTdhZGNiMmZhOWU3M2ZlOGY0MWQ4ODYxZCZwSWQ9MTMmdG9rZW49Y2thb21ha2FlcXFrbQ==",// 领取地址,用来展示二维码,携带token
        "gift_data":[{
            "gift_receive_type": 1, // 可领会员类型,1 黄金会员,2 星钻会员(int型)
            "gift_receive_time": “30天”, // 可领会员时长(天数)
            "gift_receive_deadline": 1608863300, // 赠送会员领取有效期(时间戳) (int型)
            "gift_elapsed_time": “0天” // 赠送会员已消耗时长(天数)
        },
        ...,
        ],
    },
    "msg": "成功"
}

# 附录

# 返回错误码定义

返回码code 描述 备注
A00000 处理成功
Q00301 参数错误(如账号不可为空,合作方编号为空等)
Q00307 签名错误
Q00332 系统错误
Q00309 合作方产品不支持领取
Q00307 没有可领取的黄金会员

# MD5加密描述

采用MD5计算签名,MD5密钥由爱奇艺提供,具体计算方法如下:
1、 假设共有三个参数 pUid="1583902"、partner="ott_test"、MD5密钥="123456789";
2、 按参数名按pUid_partner_key排列,再用“_”连接后得到串A,即为“1583902_ott_test_123456789”;
3、 计算拼接串的MD5即为最终签名值,注意使用UTF-8编码计算 ,MD5后的签名最后都转成小写。
举例:
参数:pUid="1583902"、partner="ott_test", MD5密钥:123456789
最终签名串:f80118ff523f25eda67cb799bdc9c52d

# JAVA版本示例代码如下:

/**
 * MD5签名测试类
 *
 * @author zdg
 * @date 2019/4/16 9:39
 */
public class Md5Test {
    private static final char[] DIGITS = {'0', '1', '2', '3', '4', '5', '6',
        '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
   @Test
  public void main(String[] args) { 
    String pUid="1583902";
    String partner="ott_test";
    String md5key = "123456789";
    StringBuffer str = new StringBuffer(pUid);
    str.append("_").append(partner).append("_").append(md5key);
    // MD5签名工具类,可以自己实现, MD5实现参照
    String targetSign = EncodeUtils.MD5(str.toString(), "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.io.UnsupportedEncodingException;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

/**
 * MD5签名测试类
 *
 */
public class EncodeUtils {

    private static final char[] DIGITS = {'0', '1', '2', '3', '4', '5', '6',
        '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
    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 ott_test

所需密钥:

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

← OTT查询赠送黄金的历史订单接口 OTT页面领取黄金会员接口 →