用户在搜索“基础代谢率”“BMR 计算”等泛需求时,搜索结果页会展现基础代谢率计算器卡片。用户可在结果页设置性别、年龄、身高、体重,点击按钮跳转至资源方落地页查看自己的基础能量代谢计算结果。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
bmr_calculator | string | 服务类型 | 可选,提供的服务类型-基础代谢率计算器 |
通过平台上传 txt 文件
资源方仅需要通过 txt 文件上传一个空的 intent 到平台,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"bmr_calculator":""} |
通过开放 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 | 资源编号 | 48063 |
当前资源的 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 | 必选 | 点击卡片标题的跳转链接地址,跳转至资源方能够进行 BMR 计算的落地页。该字段需返回 H5 或智能小程序页面路径,例如:“/page/of/target” |
submit_url | string | 必选 | 点击“计算代谢率”按钮的跳转路径,跳转至计算结果页。以“/page/of/target?param1={{val1}}¶m2={{val2}}¶m3={{val3}}¶m4={{val4}}”形式上传。其中,param1、param2、param3、param4 对应用户选择或输入的性别选项值、年龄、身高、体重数值的 key,可根据需要改写为具体的名称。{{val1}}、{{val2}}、{{val3}}、{{val4}}是固定字符,会依次替换为用户输入的具体数值,请不要修改 |
options | array | 必选 | 性别选项列表 |
options.text | string | 必选 | 性别下拉框中各选项的文案,如:“男性”、“女性”,最短 1 个字符 |
options.value | string | 必选 | 性别下拉框中各选项对应的选项值,用于表单按钮提交路径中 param1 值的获取,最短 1 个字符 |
statement | string | 必选 | 底部声明文案,对基础代谢率含义的说明,不超过 24 个字符 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |