字体 - 站酷海洛正版图片，视频，音乐，字体素材交易平台

对接指南

1、咨询客户经理。

客户经理邮箱：xingyu@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_id 、 client_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分钟。

字体分类API

接口地址 font/categories
请求方法 GET
参数列表
返回结果

{
  "result": true,
  "data": [
    {
      "id": 1,
      "name": "宋体"
    },
    {
      "id": 2,
      "name": "楷体"
    },
    {
      "id": 3,
      "name": "行书"
    }
  ]
}

字体风格API

接口地址 font/styles
请求方法 GET
参数列表
返回结果

{
  "result": true,
  "data": [
    {
      "id": 1,
      "name": "正规字体"
    },
    {
      "id": 3,
      "name": "美术字体"
    },
    {
      "id": 4,
      "name": "毛笔"
    }
  ]
}

字体搜索API

接口地址 font/search
请求方法 GET

参数列表

参数名	必填	类型	说明
keyword	否	string	查询的关键字
page	否	int	哪一页默认第一页
per_page	否	int	每页数量最大值 100
category_id	否	int	分类 ID
style_id	否	int	风格 ID

返回结果

{
  "result": true,
  "data": {
    "per_page": 100, //每页数量
    "total": 666666, //总数量
    "list": [
      {
        "id": "116",
        "name": "站酷锐锐体",
        "characters_cnt": "9283",   //字数
        "cover": "https://ali.image.hellorf.com/images/7574858da25ce4ee5f662db80bb62f77_plus_new.png?x-oss-process=image/resize,w_400"    //封面图
      },
      {
        "id": "117",
        "name": "站酷彤彤体",
        "characters_cnt": "6666",
        "cover": "https://ali.image.hellorf.com/images/048b75c70689eec7da661e440f3124bb_plus_new.png?x-oss-process=image/resize,w_400"
      },
      {
        "id": "178",
        "name": "文悦方糖体",
        "characters_cnt": "6936",
        "cover": "https://ali.image.hellorf.com/images/9c1284e4e5ae63e5f5b6acf1d24472c3_plus_new.png?x-oss-process=image/resize,w_400"
      },
    ]
  }

字体详情API

接口地址 font/detail
请求方法 GET
参数列表

参数名必填类型说明

font_id 是 string 字体 ID
返回结果

参数名	必填	类型	说明
font_id	是	string	字体 ID

{
    "result": true,
    "data": {
        "font": {
            "id": "116",
            "name": "站酷锐锐体",
            "cover": "https://ali.image.hellorf.com/images/7574858da25ce4ee5f662db80bb62f77_plus_new.png?x-oss-process=image/resize,w_600",   //封面
            "description": "站酷锐锐体，字形饱满丰盈，卡通可爱，充满稚气感和童真气息，不规则四边形的笔画组合，使得字体灵活多变，趣味十足。本款字形适用于个性类标题设计，广告设计，儿童读物类设计等应用环境。",
            "encoding": "GBK（简繁扩展）",     //字体编码
            "format": "TTF",    //字体格式
            "characters_cnt": 9283,
            "purpose": "商业用途/编辑用途"
            "font_category_id": "9",
            "font_style_ids": "2,9,10,11,17,24,23"
        },
        "author": "Jantana Phattha"
        "permissions": [
            {
                "id": 13470,
                "name": "字体全媒体授权-一年全媒体",
                "price": "66.00",
                "type": "all",
                "code": "GBK（简繁扩展）",
                "characters_cnt": 9283
            }
        ]
    }
}

购买字体API

接口地址 font/purchase
请求方法 POST
参数列表

参数名必填类型说明

font_id 是 string 字体 ID

permission_id 是 int 权限 ID

warrant_name 是 string 授权用户名称

third_user_id 否 string 第三方用户 ID
返回结果

参数名	必填	类型	说明
font_id	是	string	字体 ID
permission_id	是	int	权限 ID
warrant_name	是	string	授权用户名称
third_user_id	否	string	第三方用户 ID

{
  "result": true,
  "data": {
    "id": 140,
    "url": "https://hellorf-download.oss-cn-beijing.aliyuncs.com/fonts/ttf/3d8424795da22cb23f15d08aafbef967.ttf?OSSAccessKeyId=LTAI4FvyBjoFRCwBPtqSe4Mc&Expires=1628250575&Signature=E9teuzyKcFWH1qsCGOMosC%2FXUi8%3D"  //下载地址
  }
}

我的购买记录API

接口地址 font/my-purchases
请求方法 GET

参数列表

参数名	必填	类型	说明
begin_at	否	TIMESTAMP	开始时间例如：2017-01-01 23:23:23
end_at	否	TIMESTAMP	结束时间例如：2017-01-01 23:23:23
is_download	否	int	是否下载默认值全部 1 是 2 否
font_id	否	string	字体 ID
per_page	否	int	每页数量默认值 10
page	否	int	哪一页默认值第一页

返回结果

{
  "result": true,
  "data": {
    "per_page": 10, //每页数量
    "total": 1, //总数量
    "list": [
      {
        "id": 140,  //购买ID
        "plus_user": { //购买用户
          "id": 14563341,
          "name": "xxx"
        },
        "real_plus_user": { //真实购买用户
          "id": 14563341,
          "name": "xxxx"
        },
        "third_user_id": "", //第三方用户ID
        "plus_permission": { //购买权限
          "id": 36,
          "name": "字体全媒体授权-一年全媒体"
        },
        "able_id": 116, //购买资源ID
        "able_type": "font", //购买资源名称
        "asset_type": "all", //资源大小
        "warrant_name": "xxx", //授权名称
        "download_at": "2021-08-06 11:49:35", //下载时间
        "created_at": "2021-08-06 11:49:34" // 购买时间
      }
    ]
  }
}

购买记录详情API

接口地址 font/purchase-detail
请求方法 GET
参数列表

参数名必填类型说明

purchase_id 是 int 购买 ID
返回结果

参数名	必填	类型	说明
purchase_id	是	int	购买 ID

{
  "result" : true,
  "data" : {
    "font": {
        "id": "116",
        "name": "站酷锐锐体",
        "cover": "https://ali.image.hellorf.com/images/7574858da25ce4ee5f662db80bb62f77_plus_new.png?x-oss-process=image/resize,w_600",   //封面
        "description": "站酷锐锐体，字形饱满丰盈，卡通可爱，充满稚气感和童真气息，不规则四边形的笔画组合，使得字体灵活多变，趣味十足。本款字形适用于个性类标题设计，广告设计，儿童读物类设计等应用环境。",
        "encoding": "GBK（简繁扩展）",     //字体编码
        "format": "TTF",    //字体格式
        "characters_cnt": 9283,
        "purpose": "商业用途/编辑用途"
        "font_category_id": "9",
        "font_style_ids": "2,9,10,11,17,24,23"
    },
    "purchase" : {
      "id" : 140, // 购买记录ID
      "permission_id" : 36, // 权限ID
      "permission_name" : "xxxxx", // 权限名称
      "plus_user_id" : 15806798, // 主账号ID
      "real_plus_user_id" : 15806798, // 实际购买账号ID
      "price" : "13.00", // 价格
      "asset_type" : "all", // 购买尺寸
      "warrant_name" : "北京站酷创意科技有限公司", // 授权主体名称
      "fileSize" : 1, // 字体默认1
      "created_at" : "2021-08-06 11:49:34" // 购买时间
    }
  }
}

授权书下载API

接口地址 font/download-warrant
请求方法 GET
参数列表

参数名必填类型说明

purchase_id 是 int 购买 ID
返回结果

参数名	必填	类型	说明
purchase_id	是	int	购买 ID

FILE

历史购买再下载API

接口地址 font/purchase-download
请求方法 GET
参数列表

参数名必填类型说明

purchase_id 是 int 购买 ID
返回结果

参数名	必填	类型	说明
purchase_id	是	int	购买 ID

{
  "result": true,
  "data": {
    "url": "https://hellorf-download.oss-cn-beijing.aliyuncs.com/fonts/ttf/3d8424795da22cb23f15d08aafbef967.ttf?OSSAccessKeyId=LTAI4FvyBjoFRCwBPtqSe4Mc&Expires=1628250575&Signature=E9teuzyKcFWH1qsCGOMosC%2FXUi8%3D" //下载地址
  }
}