智能小程序OPENCARD
开放类目

在线阅读

用户搜索书名(出版物非网文)时,可在结果页中展现在线阅读卡片,展示书记的作者、简介等基本信息,点击整卡可跳转到资源方落地页进行阅读。

示意图

intent 上传接口

当前资源 intent 意图参数

key 类型 含义 示例/说明
name string 书名 必选,如”朝花夕拾”
author string 作者 可选,如 “鲁迅”

通过平台上传 txt 文件

资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 intent 数据

当前资源分类 txt 上传文件内容示例如下:

1
2
{"name":"朝花夕拾","author":"鲁迅"}
{"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 资源编号 48020

当前资源的 intent 参数参考上节 “intent 上传接口“。

举例:发送给 webhook 的 JSON (解密后)

1
2
3
4
5
6
7
8
9
{
"type": "sp_ala",
"srcid": "48020",
"surface": "mobile",
"intent": {
"name": "朝花夕拾",
"author": "鲁迅"
}
}

从 webhook 返回的结果

外层通用数据字段

key 类型 含义 示例/说明
status integer 结果状态码,0 代表正确,1 代表无结果,
2 代表请求参数错误,3 代表内部服务错误
0
msg string 出错消息,当非 0 时提供 “”
data object 要返回的资源数据内容 JSON 对象,每个资源分类不同

当前资源分类的 data object 字段内容

key 类型 要求 说明
jump_url string 必选 点击卡片标题跳转的链接地址
item_list array 必选 左图右文列表数据,最少 1 个,最多 3 个
item_list.name string 必选 书名,如”朝花夕拾”
item_list.image string 必选 图片地址,卡片大图,比例:1140*642,需清晰且完整,与书籍本身相关
item_list.score_number number 可选 评分,可保留到小数点后一位,如:”1.2”、”4.5”
item_list.score_max_num number 可选 最大评分,最大评分一般为 5 或 10
item_list.score_text string 可选 描述评分的来源,最多 6 个字,如当当评分,知乎评分等
item_list.author string 必选 作者名,如”作者:鲁迅”
item_list.introduction string 必选 简介,不超过 200 字,最多显示两行,超过则截断
item_list.url string 必选 整卡跳转链接,点击跳转到该书的详情页中
item_list.button_url string 必选 button 上的链接,点击跳转到书籍第一页
item_list.button_text string 必选 button 上的文案,固定为”阅读”

举例:从 webhook 返回的 JSON (加密前)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"status": 0,
"msg": "",
"data": {
"jump_url": "/page/of/target?id=1",
"item_list": [
{
"name": "朝花夕拾",
"image": "https://edu-wenku.bdimg.com/v1/na/0807/2-1574821125791.jpg",
"score_number": 4.3,
"score_max_num": 5,
"score_text": "当当评分",
"author": "作者:鲁迅",
"introduction": "简介:此文集作为“回忆的记事”,多侧面地反映了作者鲁迅青少年时期的生活,形象地反映了他的性格和志趣的形成经过。前七篇反映他童年时代在绍兴的家庭和私塾中的生活情景",
"url": "/page/of/target?id=1",
"button_url": "/page/of/target?id=1",
"button_text": "阅读"
}
]
}
}
反 馈帮 助 回 到顶 部