概述

概述

快海报提供小程序分享海报生成服务,接口为 HTTP API。

API 接口域名

api.kuaihaibao.com

API 请求 scheme

出于安全考虑,仅支持 https 方式请求,不支持 http 方式

鉴权方式

先在 管理后台 > 开发 > 设置 中点击「Token 启用」

获得 token 后,需要将 token 放入请求 header 的 Authorization 字段中,如下:(把 YOUR_TOKEN_HERE 换成你生成的 token)

Authorization: Bearer YOUR_TOKEN_HERE

永远不要将 Token 存放在任何客户端里

  • 容易造成 token 泄漏,造成不必要的金钱损失
  • 小程序下载图片一般需要配置 downloadFile 域名,如果小程序中直接调用 API 使用返回我们提供的 URL,我们不保证 URL 的域名不会发生变化。一旦发生变化,您的用户将不能下载图片。所以一定要在您的服务端转存一次图片。

如果不慎遗失 token,可选择适当的时间在管理后台重置 token。

注意:重置操作会立刻失效之前的 token,重置不可逆,请谨慎操作。

最佳实践

在你的服务端做 API 请求,把我们返回的图片缓存到自己的服务器(或图片存储服务中)。

不要在客户端直接请求我们的 API,也不要把图片地址直接返回给终端用户。

sequenceDiagram participant 小程序端 participant 服务端 participant 快海报 小程序端->>服务端: 请给我一张分享海报 服务端-->>小程序端: 有缓存,直接返回缓存图片 服务端->>快海报: 无缓存,请求快海报 快海报->>服务端: 返回海报图 服务端-->>服务端: 缓存图片,以备后用 服务端->>小程序端: 返回缓存后的图片

缓存(主动存储快海报生成的分享图)

缓存的优势

提高响应速度,降低响应时间,减少请求快海报的次数(省钱)

何时使用缓存

以小程序生成分享海报为例,以下情况应当使用缓存:

  1. 生成图片不受生成用户信息影响时
  2. 生成二维码不带有用户相关的返利、加成、统计信息时
  3. 生成图片与生成时间无关时

例如:

  • 分享不带分享者头像、昵称的图文详情
  • 匿名分享一张照片
  • 分享无返利效果的电商产品

何时不应缓存

凡是和分享者个人信息有关、和分享时间有关的海报,都不应当缓存,每次生成都需要请求快海报服务。

例如:

  • 带分享者头像、昵称、个人信息的图片
  • 分享二维码对分享者有返利效果等好处时
  • 分享二维码有针对分享者的统计功能时

我们判断这些情况生成的完全相同的海报的概率很小、频率很低,使用缓存反而会使低频资源占据大量存储空间,经济上和效率上都不划算。