接入指南
1.1. 整体介绍
1.2. 术语说明
1.3. 说明
2. 具体操作
2.1. 开放平台
1.
2.
3.
4.
2.2. 开放搜索 OpenAPI
${xxx} 是需要用户手动替换的。2.2.1. 请求接口获取 tenant access token
2.2.2. 请求创建数据范式
1.
2.
card_key 指定数据范式对应的模版，目前支持search_common_card；模版信息如下：
icon_urltitlesummaryfootertag1,tag2,tag3source_url，移动端为source_url_mobile3.
fields_mapping 定义用户字段到模板字段的映射display_field字段为模板字段，目前支持的字段有summary,footer,tag1,tag2,tag3 ；data_field支持模版语言且支持拼接, 如这是自定义的字段1: ${field1} 和 字段2: ${field2} "display": {
"card_key": "search_common_card",
"fields_mapping": [
{
"data_field": "${priority}",
"display_field": "tag1"
},
{
"data_field": "${status}",
"display_field": "tag2"
},
{
"data_field": "${type}",
"display_field": "tag3"
},
{
"data_field": "this is ${summary} and content is ${content}",
"display_field": "summary"
},
{
"data_field": "${_create_time}",
"display_field": "footer"
}
]
}1.
summary 和 footer 字段的映射支持文本类型和数值类型以及两者的拼接； tag1,tag2,tag3 只支持类型为tag的字段映射footer字段， 当 data_field 为 ${_create_time} 或 ${_update_time} 时，展示时会解析为 创建于 xxx 和 更新于 xxx 且支持i18n，无需另外配置；2.
properties_create_time，_update_time，_item_id，_title的字段为特殊字段；除此外，字段命名不能以_开头_create_time，_update_time，_title，_item_id分别对应着metadata中的create_time，update_time，title以及请求体中的id字段；如下为创建item时请求体的metadata部分{
"id":"id_1",
"metadata": {
"create_time": 0,
"source_url": "",
"source_url_mobile": "",
"title": "",
"update_time": 0
}1.
is_searchable 与可排序属性 is_sortable 不能同时为trueis_sortable 可以为 true；只有文本类型字段的 is_searchable 可以为 truetag 类型的is_searchable和的is_sortable都不能为true2.2.3. 请求创建数据源
1.
1.
i18n 目前支持：i18n_name、i18n_description两个字段，如果没有取到对应的 i18n 字段，则会显示默认字段。2.
3.
templateschema_idtemplate 目前仅支持 search_common_card，schema_id是创建好的数据范式对应的IDschema_id会优先绑定对应的数据范式，否则会根据template对应的模版来创建数据源，建议使用schema_id的方式来创建数据源。2.2.4. 请求创建数据项
1.
2.
3.
"display": {
"card_key": "search_common_card",
"fields_mapping": [
{
"data_field": "${priority}",
"display_field": "tag1"
},
{
"data_field": "${status}",
"display_field": "tag2"
},
{
"data_field": "${type}",
"display_field": "tag3"
},
{
"data_field": "${content}",
"display_field": "summary"
},
{
"data_field": "${create_time}",
"display_field": "footer"
}
]
}1.
metadata 中的 title 字段，该字段支持搜索2.
field_mapping定义的映射到icon_url字段的信息；支持 png、jpeg 格式图片，>= 200*200 像素；icon_url为structured_data中字段 {
"structured_data":"{\icon_url\":"\www.feishu.com\"}"
}1.
field_mapping中定义的映射到summary字段的信息，content为structured_data中字段 {
"structured_data":"{\content\":"\测试摘要\"}"
}1.
field_mapping定义的映射到summary字段的信息；create_time为metadata中字段2.
field_mapping定义的映射到tag1``tag2``tag3字段的信息，为structured_data中字段{
"structured_data":"{\"type\":\"person\",\"status\":\"open\",\"priority\":\"nomal\"}"
}1.
metadata 中的 source_url 字 段中指定的链接,为metadata中字段1.
title 和 summary 字段来进行搜索。2.
structured_data{
"id": "item_1",
"acl": [{
"access": "allow",
"type": "user",
"value": "everyone"
}],
"metadata": {
"create_time": 1627460490,
"source_url": "www.baidu.com",
"title": "title1",
"update_time": 1627460490
},
"structured_data": "{\"content\":\"测试摘要\",\"icon_url\":\"https://sf3-ttcdn-tos.pstatp.com/obj/mosaic-legacy/6eed0002408143b46441\"，\"priority\":\"nomal\"，\"status\":\"open\"，\"type\":\"urgent\"}"
}1.
id 字段必须每个数据项唯一，否则会覆盖；2.
3. 附录
3.1. ACL 说明（没有需求可跳过）
[{
"access": "allow", // 使用 allow 或者 deny
"type": "user",
"value": "everyone"
},{
"access": "deny", // 使用 allow 或者 deny
"type": "user",
"value": "${ID}"
},
// ...
]1.
aclaclaclaccessallowtype 为 user ，当 access 为 allow ，value 设置为 everyone 则全员可搜；2.
type 为 user ，则 value 为用户的 employeeID。获取方式为租户的管理员在“飞书管理后台”中查看（可批量导出）。如下图红框中的“6c368g48”；
1.
2.
{
"id": "item_1",
"acl": [],
"metadata": {
"create_time": 1632626242,
"source_url": "https://www.feishu.cn",
"title": "item01",
"update_time": 1632626242
},
"structured_data": "{\"summary\":\"由北京发来贺电\",\"icon_url\":\"https://sf3-ttcdn-tos.pstatp.com/obj/mosaic-legacy/6eed0002408143b46441\"}"
}acl 字段，item_1 这个数据项全员不可见；{
"id": "item_2",
"acl": [{
"access": "allow",
"type": "user",
"value": "everyone"
}],
"metadata": {
"create_time": 1632626242,
"source_url": "https://www.feishu.cn",
"title": "item02",
"update_time": 1632626242
},
"structured_data": "{\"summary\":\"由北京发来贺电\",\"icon_url\":\"https://sf3-ttcdn-tos.pstatp.com/obj/mosaic-legacy/6eed0002408143b46441\"}"
}{
"id": "item_3",
"acl": [{
"access": "allow",
"type": "user",
"value": "user1_employeeID"
}, {
"access": "allow",
"type": "user",
"value": "user2_employeeID"
}],
"metadata": {
"create_time": 1632626242,
"source_url": "https://www.feishu.cn",
"title": "item03",
"update_time": 1632626242
},
"structured_data": "{\"summary\":\"由北京发来贺电\",\"icon_url\":\"https://sf3-ttcdn-tos.pstatp.com/obj/mosaic-legacy/6eed0002408143b46441\"}"
}{
"id": item_4",
"acl": [{
"access": "allow",
"type": "user",
"value": "everyone"
}, {
"access": "deny",
"type": "user",
"value": "user2"
}],
"metadata": {
"create_time": 1632626242,
"source_url": "https://www.feishu.cn",
"title": "item04",
"update_time": 1632626242
},
"structured_data": "{\"summary\":\"由北京发来贺电\",\"icon_url\":\"https://sf3-ttcdn-tos.pstatp.com/obj/mosaic-legacy/6eed0002408143b46441\"}"
}
扫码加入交流群