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

  • TOB激活码直充接口

  • OTT直充接口

  • OTT自动续费接口

  • OTT激活码直充接口

  • 通用接口

  • 内容点播接口

  • 卡券类接口

  • 用户信息接口

  • 会员福利接口

    • 福利直充接口
    • 福利直充校验接口
    • 福利直充退单接口
    • 合作方福利核销接口
    • 合作方福利订单回传接口
  • 合作方客户FV管理

# 福利直充校验接口

# 简介

# 业务介绍

合作方福利直充校验标准接口

# 接口定义

# 应用场景

由合作方提供本接口供爱奇艺调用,用于进行福利直充前的校验,包括但不限于库存是否充足、直充是否超限、用户是否可直充等

# URL

由合作方提供

# 请求方式

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

# 请求参数

序号 变量名 名称 是否必须 类型 说明
1 customer 商户标识 是 String 固定为iqiyi
2 biz 业务标识 是 String 爱奇艺侧按业务分配
4 item 商品标识 是 String 要开通的商品标识,由合作方定义
5 amount 商品数量 否 Integer 要开通的商品数量,默认为1
6 account 用户账号 是 String 要开通权益的用户账号/手机号
7 sign 接口签名 是 String 调用签名,签名秘钥由合作方提供,签名算法参见下方附录

# 返回参数

字段名 类型 说明
code String 返回码
msg String 返回信息
data Object 返回数据

# 返回码定义

返回码code 描述 备注
A00000 校验成功 表示用户可直充
Q00114 用户未注册 表示用户未注册,如无用户必须注册的限制则忽略
Q00206 购买超限 表示用户购买产品次数已超过限制,如无购买限制则忽略
Q00219 无库存 表示产品库存已消耗完,如无库存限制则忽略
Q00332 其他错误 表示直充错误,返回此错误码时,msg中需要明示错误原因
Q00401 活动已结束 表示产品已不在售卖期

# 返回示例

data格式如下:

{
    "orderCode":"100000001", #爱奇艺订单号(String型)
    "bizCode": "200000002", #业务订单号,本次直充对应的订单号,无订单时可使用券码编号等能够唯一区分本次交易的信息(String型)
    "account":"8888888", #到账用户账号(String型)
}

# 在线测试

参数 值 备注
hosts -- 合作方提供接口地址
customer benefit_test
biz benefit
md5Key e85854766ad326f9

# 附录

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

# 常见问题

# 签名错误

请仔细阅读按签名规则和示例代码,需要注意:参数值为null的,key也会参与计算签名,所以最好传参就去掉值为null的key。MD5后的签名最后都转成小写

← 福利直充接口 福利直充退单接口 →