用户搜索书名(出版物非网文)时,可在结果页中展现书评卡片,展示书籍的作者、简介等基本信息和两条书评的预览,点击可跳转到资源方落地页查看书评的详情。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
name | string | 书名 | 必选,如”朝花夕拾” |
author | string | 作者 | 可选,如 “鲁迅” |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"name":"朝花夕拾","author":"鲁迅"} |
通过开放 API 上传
详细接入方式参见 API 上传方式。
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48046 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 点击卡⽚的跳转路径,跳转后需锚定到结果页上所展示的书评上,该字段需返回 H5 或智能小程序页面路径,例如“/page/of/target” |
stars | number | 必选 | 评分星数,1-10 之间的数字,最多保留小数点后一位,例如:8.9 |
star_maxnum | number | 必选 | 最大评分,1-10 之间的整数,例如:10 |
score_number | integer | 必选 | 评分人数,例如:56789 |
book_name | string | 必选 | 书名,最短 1 个字符,最长 15 个字符,例如:朝花夕拾 |
book_author | string | 必选 | 书籍作者,最短 1 个字符,最长 15 个字符,例如:鲁迅 |
comments_list | array | 必选 | 评论列表,最少 1 个,最多 2 个 |
comments_list.avatar | string | 必选 | 评论者头像,例如:https://ss0.baidu.com/6ONWsjip0QIZ8tyhnq/it/u=2379086268,2130850456&fm=58 |
comments_list.nickname | string | 必选 | 评论者昵称,最短 1 个字符,最长 10 个字符,例如:去影无踪 |
comments_list.time | integer | 必选 | 评论时间戳,毫秒,如:1584005199221 |
comments_list.content | string | 必选 | 评论内容,最短 1 个字符,最长 200 个字符,例如:这本书真不错,中西的思想确实有一点不同 |
comments_list.url | string | 必选 | 评论跳转路径,跳转后需锚定到结果页上所展示的书评上,该字段需返回 H5 或智能小程序页面路径,例如“/page/of/target” |
举例:从 webhook 返回的 JSON (加密前)
1 | { |