用户在搜索名片设计,名片生成等需求时,在结果页展示名片设计卡片。点击上图下文结构可分别跳转至各自的名片设计页面,点击标题可以跳转至名片设计详情页(端内小程序+端外H5)。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
businesscard | string | 服务类型 | 可选,提供的服务类型-名片设计 |
通过平台上传 txt 文件
资源方仅需要通过txt 文件上传一个空的intent到平台,txt 文件的具体要求参见接入流程-上传 Intent 数据
当前资源分类 txt 上传文件内容示例如下:
1 | {"businesscard":""} |
通过开放 API 上传
详细接入方式参见API上传方式
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48128 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的data
object字段内容
| key | 类型 | 要求 | 说明 |
| ———- | —— | —- | ——————————————————————————————————————————————————————————————————————————— |
| adjective | string | 必选 | 类目名称,固定为:名片设计 |
| jump_url | string | 必选 | 点击卡片标题的跳转路径,应跳转至资源方落地页,该落地页应含有名片设计功能。如果收到的surface请求是mobile,请返回小程序路径,如/page/of/target;如果收到的surface请求是web_h5,请返回H5路径,如/page/of/target(以/开头,不含域名) |
| tag | array | 可选 | 横滑Tag 列表,最少2个,最多10个 |
| tag.text | string | 可选 | tag文案 |
| tag.url | string | 可选 | tag链接地址。如:“/page/of/target” |
| item | array | 必选 | 上图下文列表数据配置,最少3个,最多10个 |
| item.image | string | 必选 | 图片链接,相应名片的封面图,以“https”开头的图片链接,图片横竖比3:2 |
| item.title | string | 必选 | 文字标题,名片标题,如:个性简约名片设计 |
| item.url | string | 必选 | 点击上图下文结构的跳转链接地址,跳转落地页应满足对应名片的设计需求。url字段需返回H5或智能小程序页面路径。如:“/page/of/target“ |
| slink | array | 可选 | 子链列表,最少2个,最多3个 |
| slink.text | string | 可选 | 子链文案,最短1个字符,最长6个字符 |
| slink.url | string | 可选 | 子链跳转链接,如:“/page/of/target” |
| statement | string | 可选 | 底部声明文案,对名片设计卡片的说明,不超过24个字符 |
1 | { |