主动回调说明

易盾提供主动回调和被动回调数据两种方式,主动回调以数据为维度设置回调地址;易盾方产品回调数据后,主动调用客户提供的http地址将回调数据推送给客户

主动回调接入

客户接入主动回调的方式很简单,只需要在调用在线检测接口请求参数中指定了回调通知参数callbackUrl(即一个http(s)协议接口的URL),则需要支持POST方法,传输数据编码采用utf-8

业务类型回调参数名称类型最大长度描述
视频callbackUrlString256视频在线提交参数中添加callbackUrl字段

您服务端接收到我们推送的结果后,返回的HTTP状态码为200时,表示推送成功,其他的HTTP状态码均视为您接收失败,我们将每隔10分钟推送一次,如果一直失败,持续一天后不再推送;我们主动回调数据接口超时时间设置为2s,为了保证顺利接收数据,客户需保证接收接口性能稳定并且保证幂等性。

通信协议

HTTP(S)

请求方法

客户提供的主动回调数据接收接口,需支持 POST 方法。

字符编码

所有接口的请求数据编码皆为 utf-8。

请求公共参数

参数名称类型是否必传描述
secretIdStringY产品秘钥 id ,由易盾反垃圾云服务分配,产品标识
businessIdStringY业务id ,由易盾反垃圾云服务分配,业务标识
signatureStringY请求签名,用来验证此次请求的合法性,具体算法见 接口鉴权
callbackDataStringY主动回调推送数据,格式为json字符串

secretId,businessId,signature参数用来给数据接收接口做签名鉴权用

接口鉴权

客户主动回调接收接口可以通过业务开通时易盾分配的密钥信息字段进行接口鉴权,鉴权粒度是否要精确到业务级别,用户可以根据需要自行决定

/**
 * 通过HttpServletRequest做签名验证
 * 
 * @param request
 * @return
 */
public static boolean verifySignature(HttpServletRequest request) {
    String secretId = request.getParameter("secretId");
    String businessId = request.getParameter("businessId");
    String signature = request.getParameter("signature");
    if (StringUtils.isEmpty(secretId) || StringUtils.isEmpty(signature)) {
        // 签名参数为空,直接返回失败
        return false;
    }
    Map<String, String> params = Maps.newHashMap();
    for (String paramName : request.getParameterMap().keySet()) {
        if (!"signature".equals(paramName)) {
            params.put(paramName, request.getParameter(paramName));
        }
    }
    // SECRETKEY:产品私有密钥 SECRETID:产品密钥ID BUSINESSID:业务ID,开通服务时,易盾会提供相关密钥信息
    String serverSignature = getSignature(SECRETKEY, params);
    return signature.equals(serverSignature) && SECRETID.equals(secretId) && BUSINESSID.equals(businessId);
}
/**
* 生成签名信息
* @param secretKey 产品私钥
* @param params 接口请求参数名和参数值map,不包括signature参数名
* @return
* @throws UnsupportedEncodingException
*/
public static String genSignature(String secretKey, Map<String, String> params) throws UnsupportedEncodingException {
    // 1. 参数名按照ASCII码表升序排序
    String[] keys = params.keySet().toArray(new String[0]);
    Arrays.sort(keys);

    // 2. 按照排序拼接参数名与参数值
    StringBuffer paramBuffer = new StringBuffer();
    for (String key : keys) {
        paramBuffer.append(key).append(params.get(key) == null ? "" : params.get(key));
    }
    // 3. 将secretKey拼接到最后
    paramBuffer.append(secretKey);

    // 4. MD5是128位长度的摘要算法,用16进制表示,一个十六进制的字符能表示4个位,所以签名后的字符串长度固定为32个十六进制字符。
    return DigestUtils.md5Hex(paramBuffer.toString().getBytes("UTF-8"));
}

视频点播主动回调数据结构

callbackData为Json字符串,数据结构如下:

{
    "taskId":"ed7dv8g3lk98bvx435s444444",
    "callback":"自定义内容",
    "status":0,
    "level":2,
    "evidences":[
        {
            "type":1,
            "url":"https://illegal-video.nosdn.127.net/xxx.jpg",
            "beginTime":156240,
            "endTime":156240,
            "labels":[
                {
                    "label":110,
                    "level":2,
                    "rate":0.979219,
                    "subLabels":[
                        {
                            "subLabel":11000,
                            "rate":0.979219
                        }
                    ]
                }
            ]
        },
        {
            "type":1,
            "url":"https://illegal-video.nosdn.127.net/xxxx.jpg",
            "beginTime":146160,
            "endTime":146160,
            "labels":[
                {
                    "label":110,
                    "level":2,
                    "rate":0.997613,
                    "subLabels":[
                        {
                            "subLabel":11000,
                            "rate":0.997613
                        }
                    ]
                }
            ]
        },
    ]   
}