智能小程序OPENCARD
开放类目

1输入框+1选项框

搜索结果页会展现 1 输入框+1 选项框模板卡片。用户在结果页输入一个文本内容以及设置一个选择内容,点击按钮跳转至资源方落地页查看结果。
如果你有优质的小程序适合接入这个样式的卡片,可立即申请接入

示意图

如果你有优质的小程序适合接入这个样式的卡片,可立即申请接入

intent 上传接口

当前资源 intent 意图参数

key 类型 含义 示例/说明
tool_name string 服务类型 可选,提供的服务类型。如:“公司店铺起名”

通过平台上传 txt 文件

txt 文件的具体要求参见接入流程-上传 Intent 数据

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

1
{"tool_name":"公司店铺起名"}

通过开放 API 上传

详细接入方式参见API 上传方式

Webhook API

发送给 webhook 的请求

公共字段

key 类型 含义 示例/说明
type string 请求类型(大部分开发者可不关心) 在小程序阿拉丁下永远为 “sp_ala”
surface string 搜索场景(大部分开发者可不关心) mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索
srcid string 资源编号 每个资源分类不同
intent object 搜索意图参数 JSON 对象,每个资源分类不同
location object 用户定位信息 JSON 对象
location.province string 用户所在省份 “北京”/“浙江”,不含行政区划单位,例如”市、省、自治区”,可能为空
location.city string 用户所在城市 “北京”/“杭州”,不含行政区划单位,例如”市”,可能为空
query_info object 用户表达的位置信息,应优先选用用户表达的位置信息进行检索 JSON 对象
query_info.query_province string 用户 Query 中指定的省份 “北京”/“河南”,不含行政区划单位,例如”市、省、自治区”,可能为空
query_info.query_city string 用户 Query 中指定的地级市 “北京”/“开封”,不含行政区划单位,例如”市”,可能为空
query_info.query_county string 用户 Query 中指定的县、区 “海淀”/“兰考”,不含行政区划单位,例如”县、区”,可能为空

当前资源 srcid 资源编号

key 类型 含义 设定
srcid string 资源编号 48084

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"type": "sp_ala",
"srcid": "48084",
"surface": "mobile",
"intent": {
"tool_name": ""
},
"location": {
"province": "浙江",
"city": "杭州"
},
"query_info": {
"query_province": "北京",
"query_city": "北京",
"query_county": "海淀"
}
}

从 webhook 返回的结果

外层通用数据字段

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

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

key 类型 要求 说明
tool_name string 必选 开发者所提供的工具服务的名称,显示在标题处,此处只能显示工具的名称,不得显示品牌名等其他信息
jump_url string 必选 点击卡片标题的跳转链接地址,跳转至能够提供该工具服务的落地页,落地页内容必须与结果页卡片保持高度一致,不得有与所提供的工具服务无关的信息。该字段需返回 H5 或智能小程序页面路径,如果收到的 surface 请求是 mobile,请返回小程序路径,如果收到的 surface 请求是 web_h5,请返回 H5 路径,例如:“/page/of/target”(以/开头,不含域名),若跳转至 H5 或智能小程序首页(无路径),则需要返回“/?from=baidu”。
tag array 可选 等分 Tag 列表,最少 3 个,最多 5 个
tag_text string 可选 Tag 文案,最短 1 个字符,最长 6 个字符
tag_url string 可选 Tag 链接地址。如:“/page/of/target(以/开头,不含域名)”
submit_url string 必选 点击按钮的跳转路径,跳转至计算结果页。以“/page/of/target?param1={{val1}}&param2={{val2}}”形式上传。其中,param1 对应用户输入的文本框 key,param2 对应用户选择列表的 key,可根据需要改写为具体的名称。{{val1}}、{{val2}}是固定字符,会替换为用户输入的具体数值,请不要修改
item1 string 可选 输入框表单名称,最多 4 个字
input_text string 必选 输入框提示文案,最多 18 个字
unit string 可选 表单单位,可选择以下单位:“平方米”、“米”、“厘米”、“千克”、“克”、“元”、“万元”、“百分号”、“年”、“瓦”、“千瓦”、“千米”、“时”、“分”、“秒”、“天”、“月”、“岁”
item2 string 必选 选择表单名称,最多 4 个字
options array 可选 选项列表数据,选项列表,最少 2 个,最多 25 个
options_text string 必选 选项文案
options_value string 必选 选项值,各选项对应的计算数值
button_text string 必选 按钮文案,最多 6 个字
slink array 可选 子链列表,最少 2 个,最多 3 个
slink_text string 可选 子链文案,最短 1 个字符,最长 6 个字符
slink_url string 可选 子链跳转链接,如:“/page/of/target”(以/开头,不含域名)
statement string 可选 底部声明文案,对卡片进行注释说明,不超过 24 个字符。

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"status": 0,
"msg": "",
"data": {
"tool_name": "工具名称",
"jump_url": "/page/of/target?id=1",
"tag": [
{ "tag_text": "tag1", "tag_url": "/page/of/target?id=1" },
{ "tag_text": "tag1", "tag_url": "/page/of/target?id=1" },
{ "tag_text": "tag1", "tag_url": "/page/of/target?id=1" },
{ "tag_text": "tag1", "tag_url": "/page/of/target?id=1" }
],
"submit_url": "/page/of/target?id=1&param1={{val1}}&param2={{val2}}",
"item1": "表单名称",
"input_text": "输入框提示文案",
"unit": "米",
"item2": "选择列表",
"options": [
{ "options_text": "A", "options_value": "A" },
{ "options_text": "A", "options_value": "A" },
{ "options_text": "A", "options_value": "A" },
{ "options_text": "A", "options_value": "A" }
],
"button_text": "按钮文案",
"slink": [
{ "slink_text": "短链", "slink_url": "/page/of/target?id=1" },
{ "slink_text": "短链", "slink_url": "/page/of/target?id=1" },
{ "slink_text": "短链", "slink_url": "/page/of/target?id=1" }
],
"statement": "卡片注释说明"
}
}
反 馈帮 助 回 到顶 部