曲谱

曲谱

用户在搜索曲谱时，搜索会展现“曲谱“卡片，提供曲谱大图信息，用户可进一步点击进入落地页，满足用户的需求。

示意图

intent 上传接口

当前资源 intent 意图参数

key	类型	含义	示例/说明
music	string	曲谱的歌曲名	“卡农”
type	string	曲谱的类型	“钢琴谱”/“吉他谱”

通过平台上传 txt 文件

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

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

{"music":"卡农","type":""}
{"music":"成都","type":"吉他谱"}
{"music":"国歌","type":""}
{"music":"国歌","type":"钢琴谱"}

说明：提交{“music”:”国歌”,”type”:””}可以在query=”国歌曲谱”，query=”国歌简谱查询”，query=”国歌五线谱”等一类query下召回；提交{“music”:”国歌”,”type”:”吉他谱”}可以在query=”国歌吉他谱”,query=”国歌吉他谱查询下召回；如果想尽可能多召回query，请尽可能多提交更多种类的intent数据。

通过开放 API 上传

未开放

Webhook API

发送给 webhook 的请求

公共字段

key	类型	含义	数据说明
type	string	请求类型(大部分开发者可不关心)	在小程序阿拉丁下永远为 “sp_ala”
surface	string	搜索场景(大部分开发者可不关心)	mobile: 支持小程序的移动搜索，web_h5: 支持 H5 的移动搜索
srcid	string	资源编号	每个资源分类不同
intent	object	搜索意图参数	JSON 对象，每个资源分类不同

当前资源 srcid 资源编号

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

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

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

{
  "type": "sp_ala",
  "srcid": "5523",
  "surface": "mobile",
  "intent": {
    "music": "国歌",
    "type": ""
  }
}

从 webhook 返回的结果

外层通用数据字段

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

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

key	类型	要求	说明
jump_url	string	必选	卡片标题的跳转链接,跳转到展示曲谱的页面
image	string	必选	曲谱相关背景图片,像素1140*642

从开发者服务器返回的 JSON (加密前)

{
    "status": 0,
    "msg": "",
    "data": {
        "image": "https://example.com/img.jpg",
        "jump_url": "/path/to/page"
    }
}