鹿推推-品牌监测API
    • 鹿推推-API资源接入说明
    • API品牌监测核心接口
      • 0.1 基础配置-已接入AI平台列表
        POST
      • 1.1 监测小组-新建监测小组
        POST
      • 1.2 监测小组-全部监测小组
        POST
      • 2.1 监测任务-创建监测任务
        POST
      • 2.2 监测任务-统一查询/状态同步
        POST
      • 2.3 监测任务-获取原始结果
        POST
      • 2.4 监测任务-编辑品牌词
        POST
    • API品牌监测收费接口
      • 信源分析接口
        POST
      • 分享报告接口
        POST
      • 竞品对比接口
        POST

    鹿推推-API资源接入说明

    欢迎使用 鹿推推API对接文档#

    1. 概述#

    本规范详细描述了接入方对接鹿推推开放平台-API资源的接口内容,包含接口详细数据项、接口交互规则、接口规范等系统对接、数据交互整体方案及技术约束。本文档读者对象为双方相关技术人员等。

    2.API调用方法详解#

    鹿推推API 是基于HTTP协议来调用,开发者可根据开放平台的协议封装HTTP请求进行调用,以下主要是针对如何封装HTTP请求进行API调用的原理进行详细解说。请求方式统一为:
    HTTP POST

    2.1 调用入口#

    调用API的服务URL地址,开放平台目前提供了2个环境给外部机构使用:测试环境、正式环境。
    接口地址前缀: https://ai.lutuitui.com/api 或 http://api-ai.lutuitui.com
    若无https要求,后者更稳定

    2.2 公共参数#

    每个API接口调用都必须传入的参数;用于说明报文发送方、身份认证信息、报文编号、报文发送时间、报文返回结果等内容,公共参数放在请求头中,目前支持的公共参数有:

    2.2.1 请求header参数#

    参数名称类型必填最大长度描述示例值
    x-app-idString是32应用IDapp-30252
    x-api-keyString是32应用密钥UE1JjU9ECZUvXTb5bMftQpNaZZJG8KOO
    timestampint是10时间戳时间戳,注:时间戳为10位

    2.2.2 响应参数#

    参数名称参数类型描述示例值
    codeString返回码,详见000
    descString返回码描述,详见数据字典操作成功
    contentobject业务返回数据均包含在此字段中,参见具体的API接口文档202411
    timestampString返回时间戳1728981469695

    2.2.3 分页参数#

    入参
    参数名称参数类型必填最大长度描述示例值
    perPageInteger否每页大小默认20
    pageInteger否当前页,从1开始默认1
    出参
    参数名称参数类型描述示例值
    totallong总条数
    hasNextPageboolean是否还有下一页数据false
    listlist具体的分页数据

    2.3 业务参数#

    API调用除了必须包含公共参数外,如果API本身有业务级的参数也必须传入,每个API的业务级参数请考对应API文档说明。

    2.4 安全校验#

    多种安全校验方式可选

    2.4.1 ip白名单【生产必选】#

    配置的ip白名单才能访问通过

    2.4.2 时间戳校验【可选】#

    通过调用当前时间生成时间戳, 同样的参数只允许对的时间调用。超过时间间隔调用失效。

    2.4.3 token校验【可选】#

    双方约定的token进行校验

    2.4.4 签名校验【可选】#

    *如未选择此项校验可忽略以下内容!
    2.4.4.1 签名算法#
    为了防止API调用过程中被黑客恶意篡改,调用任何一个API都需要携带签名,开放平台服务端会根据请求参数,对签名进行验证,签名不合法的请求将会被拒绝。签名过程如下:
    1.筛选并排序
    获取所有请求参数,不包括字节类型参数,如文件、字节流,剔除sign字段,剔除值为空的参数,并按照第一个字符的键值ASCII码递增排序(字母升序排序),如果遇到相同字符则按照第二个字符的键值ASCII码递增排序,以此类推。
    2.拼接
    将排序后的参数与其对应值,组合成“参数=参数值”的格式,并且把这些参数用&字符连接起来,此时生成的字符串为待签名字符串。
    3.调用签名函数
    使用各自语言对应的SHA256WithRSA(对应sign_type为RSA2)或SHA1WithRSA(对应sign_type为RSA)签名函数利用商户私钥对待签名字符串进行签名,并进行Base64编码。
    4.把生成的签名赋值给sign参数,拼接到请求参数中。
    JAVA签名示例代码
    1、拼接排序
    public static String getSignContent(Map<String, String> sortedParams) {
        StringBuffer content = new StringBuffer();
        List<String> keys = new ArrayList<String>(sortedParams.keySet());
        Collections.sort(keys);	
        int index = 0;
        for (int i = 0; i < keys.size(); i++) {
            String key = keys.get(i);
            String value = sortedParams.get(key);
            if (StringUtils.areNotEmpty(key, value)) {
                content.append((index == 0 ? "" : "&") + key + "=" + value);
                index++;
            }
        }
        return content.toString();
    }
    2、加密
    public static String rsa256Sign(String content, String privateKey,
                                    String charset) throws BaiChangApiException {
        try {       PrivateKey priKey = getPrivateKeyFromPKCS8(BaiChangOpenConstants.SIGN_TYPE_RSA,
                new ByteArrayInputStream(privateKey.getBytes()));
            java.security.Signature signature = java.security.Signature
                .getInstance(BaiChangOpenConstants.SIGN_SHA256RSA_ALGORITHMS);
            signature.initSign(priKey);
            if (StringUtils.isEmpty(charset)) {
                signature.update(content.getBytes());
            } else {
                signature.update(content.getBytes(charset));
            }
            byte[] signed = signature.sign();
            return new String(Base64.encodeBase64(signed));
        } catch (Exception e) {
            throw new BaiChangApiException("RSAcontent = " + content + "; charset = " + charset, e);
        }
    }

    3. 业务接口#

    具体接口详见:[鹿推推API]

    4.对接流程#

    5. 数据字典#

    接口返回code#

    codedesc(返回码描述)content(明细数据)备注
    200操作成功
    401token失效需要重新登录
    801数据已存在
    821请求ip不在ip白名单中具体ip
    822时间戳校验失败
    802APPID错误
    401token失效需要重新登录
    803验签失败
    805token校验失败
    901参数缺失
    999操作失败可能未知异常,联系技术确认
    810查询权限不足
    811订单号不能为空
    812请求唯一标识重复
    817请求唯一标识不能为空
    提示
    如有疑问,请联系鹿推推技术!
    修改于 2026-08-04 11:30:45
    下一页
    0.1 基础配置-已接入AI平台列表
    Built with