API文档 图库 视频 音频 字体 账号

对接指南

1、咨询客户经理。
  • 客户经理邮箱:hellorf-mkt@zcool.com.cn
2、浏览API文档,根据实际需求选择合适的API。以下是通用接入案例参考:
  • 2.1 搜索API、分类搜索API、专题搜索API、相似搜索API
  • 2.2 详情API
  • 2.3 购买API、我的购买记录API、历史购买再下载API、购买记录详情API
  • 2.4 授权书下载API
3、获取代表您身份的应用ID和应用密钥 client_idclient_secret (正式环境、测试环境各一份)
4、开发调试。
5、测试完成后部署上线。
  • 请使用测试应用的 client_id 进行测试,在测试过程中购买的动作不会真实提交,无需支付。请放心地使用我们的API进行测试。

技术必看

1、API请求说明
  • 基础地址:https://api.hellorf.com/plus/{endpoint}

  • 基础参数

    参数 必选 类型 名称 说明
    client_id string 客户应用id 从上一步对接指南获取
    nonce_str string 安全随机字符串 当前时间戳(秒),10分钟内有效期
    sign string 安全签名 见下一节
  • 安全签名规则:

    • (1) 将所有请求参数,按参数名key,ASCII码正序,不包括 sign 和 client_secret,形如:

          [
              "client_id":"4fiodcz8xjl6p8nbzfex2",
              "keyword":"云南",
              "nonce_str":"1473820208"
          ]
    • (2) 进行 URL 编码,生成字符串,形如:

      client_id=4fiodcz8xjl6p8nbzfex2&keyword=云南&nonce_str=1473820208

    • (3) 在末尾拼接上应用密钥(即client_secret),形如:

      client_id=4fiodcz8xjl6p8nbzfex2&keyword=云南&nonce_str=1473820208&client_secret=9b530aa85723c06a90879bee8f5096d7

    • (4) 最后计算字符串的 MD5 哈希值,得到 32 位小写的安全签名,形如:

      00ba2da066957662f43b668cf208e827

2、API响应说明
  • 响应数据,基本以 JSON 格式返回,文件会以 FILE 格式返回。

  • 请求失败的响应范例:

    {
        "result": false,
        "message": '失败原因',
        "code": 1001
    }
  • 请求成功的响应范例

    {
        "result": true,
        "data": {}
    }

开发SDKs

为了更高效地对接,我们提供了 Java、Go 和 PHP 三种语言的 SDK 示例(软件开发工具包),建议您参考使用。

点我前往

同时,我们也会准备相应的 Postman 调试配置,配合 nonce_str、sign 的10分钟有效期,方便您快速调试。

敬请期待

问 & 答

1. 购买获取的图片有尺寸限制吗,可以获得更大的尺寸吗?

购买图片API返回的尺寸是由商务谈定的,如需调整需要与商务联系协商。

2. 购买使用的 permission_id 如何获取?

您可以通过调用图片详情API来查询对应图片的 permission_id。

3. 为什么有时候通过图片名称搜索不出匹配名称的图片,怎样进行搜索?

1、图片搜索与文章咨询不同,它基于图片转文字算法生成n多个匹配标签,并不是以图片标题为唯一的检索依据。因此,当您尝试使用部门名称等文字内容无法检索到图片时,建议尝试使用图片元素作为关键字,例如颜色、形状和环境中的物品等,并在搜索框中输入这些关键词。请注意,搜索关键字应拆分成多个单独的单词,不支持短语搜索。
2、要进行高级的条件搜索,可以使用 and、or、not 和() 组合连接多个关键字,达到使用逻辑语句查询的高级功能。

4.热门排序是否基于全部图片进行排序?

不是。热门排序仅展示具有热度值的图片,而并非所有图片都有热度值。

5. preview_url 和 preview260_url 有什么区别?

preview_url 有水印,最大宽为450像素的缩略图,通常用作瀑布流展示。
preview260_url 无水印,最大高为260像素的缩略图,通常用作列表展示。

6. 搜索图片返回的链接过期时间是多久?

10分钟。

子账号列表

  • 接口地址 user/children

  • 请求方式 GET

  • 说明

    获取指定主账号下的所有子账号列表。接口使用本文档公共参数中的 client_idnonce_strsign 鉴权,只能查询当前应用所属主账号的子账号,不支持跨客户查询。

  • 请求参数

    参数名 必选 类型 说明
    user_id true int 指定主账号 ID。必须是当前应用所属主账号
    status false int 按账号状态筛选。0:审核中;1:正常;2:已关闭;3:已删除
    page false int 哪一页 默认第一页
    per_page false int 每页数量 默认值20
  • 返回结果

{
  "result": true,
  "data": {
    "per_page": 20, //每页数量
    "total": 2, //总数量
    "list": [
      {
        "id": 10002, //子账号ID
        "name": "设计部账号", //子账号名称
        "email": "design@example.com", //邮箱
        "phone": "13800000000", //手机号
        "company_name": "示例公司", //公司名称
        "position": "设计师", //职位
        "status": 1, //账号状态
        "status_name": "正常", //账号状态名称
        "root_user_id": 10001, //所属主账号ID
        "parent_user_id": 10001, //直接上级账号ID
        "is_direct_child": 1, //是否直属子账号
        "ancestry_depth": 1, //账号层级深度
        "created_at": "2026-07-21 10:00:00",
        "updated_at": "2026-07-21 10:00:00"
      },
      {
        "id": 10003,
        "name": "设计部二级账号",
        "email": "designer@example.com",
        "phone": "13900000000",
        "company_name": "示例公司",
        "position": "插画师",
        "status": 1,
        "status_name": "正常",
        "root_user_id": 10001,
        "parent_user_id": 10002,
        "is_direct_child": 0,
        "ancestry_depth": 2,
        "created_at": "2026-07-21 10:00:00",
        "updated_at": "2026-07-21 10:00:00"
      }
    ]
  }
}
  • 错误说明

    场景 返回说明
    user_id 为空 返回 user_id不能为空
    status 非法 返回 status参数错误
    user_id 不存在、不是主账号,或不属于当前应用所属主账号 返回 用户不存在或无权访问