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

  • TOB激活码直充接口

  • OTT直充接口

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

  • OTT激活码直充接口

  • 通用接口

  • 内容点播接口

  • 卡券类接口

  • 用户信息接口

  • 会员福利接口

  • 合作方客户FV管理

# OTT后端领取黄金会员接口

# 简介

# 业务介绍

用户在合作方侧购买会员后,爱奇艺黄金会员自动赠送至合作方账号绑定手机号上。用户可使用合作方账号绑定手机号登录爱奇艺APP,使用爱奇艺黄金会员权益。

# 领取规则

仅合作方账号有绑定手机号的用户,可自动赠送爱奇艺黄金会员至合作方账号绑定手机号上。 如果合作方账号未绑定手机号,则需要先绑定手机号,才可以赠送爱奇艺黄金会员。

# 接口定义

# 应用场景

用户在合作方购买会员后,如果合作方账号有绑定手机号,则可以绑定手机号调用此接口,为用户领取爱奇艺黄金会员自动到账。每次购买完成后,均可调用为用户领取。 反之,如果合作方账号无绑定手机号,则不可调用此接口为用户领取爱奇艺黄金会员。未领取权益会消耗,消耗完后则不可领取。 当合作方账号绑定手机号后,合作方可逐单调用领取接口,可领取全部未消耗完的待领取权益。

# 接口域名

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

# URL

/act/receiveGiftVip.action

# 请求方式

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

# 请求参数

变量名 类型 必需 说明
sign String 是 md5签名,加密规则见MD5加密描述
partnerOrderCode String 是 订单号
mobile String 是 合作方账号绑定的手机号,无绑定手机号不可领取
openId String 是 openId
partnerNo String 是 合作方编号
smsCode String 否 用户输入的短信验证码(无特殊情况不传入)

# 返回参数

变量名 名称 数据类型 说明
code 状态编码 String
data.gift_receive_time 领取时长 String 领取时长以天为单位返回 例如:62天
data.isNew 是否新用户 String "true"为新用户
msg 结果信息 String 处理成功

# 返回示例

{
  "code": "Q00301",
  "msg": "参数错误_token不能为空"
}

# 返回码定义

返回码code 描述 备注
A00000 成功
Q00301 参数错误(如合作方编号为空,合作方用户为空等)
Q00304 账号转换失败
Q00307 没有可领取的黄金会员
Q00309 合作方产品不支持领取
Q00332 系统错误
Q00349 短信验证码错误
Q00711 调用规则引擎失败
Q00712 合作方没有有效的营销策略
Q00713 合作方用户没有可用的优惠资格
Q00718 合作方不支持服务端领取

# 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_no ott_test

所需密钥:

参数 值
MD5密钥 123456789

# 在线测试

参数 值
sign 自行设定
partnerOrderCode 自行设定
mobile 自行设定
openId 自行设定
partnerNo 自行设定
点击此处进行接口调试
在线调试

← OTT绑定领取会员手机号接口 小米账号换绑手机号接口 →