Local API V2 – 扩展与书签接口

查询环境书签

接口地址

GET /openapi/v2/profiles/{profileId}/bookmarks

用于查询指定环境的书签内容和书签设置。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "profile_id": "1876881021063852034",
    "content": {},
    "settings": {}
  },
  "next": null
}

覆盖环境书签

接口地址

PUT /openapi/v2/profiles/{profileId}/bookmarks

用于覆盖指定环境的书签内容和书签设置。该操作会以请求体中的内容为准，请谨慎使用。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

请求参数

名称	类型	必填	说明
content	object	否	书签内容。
settings	object	否	书签设置。

请求示例

  -d '{
    "content": {},
    "settings": {}
  }'

复制书签到环境

接口地址

POST /openapi/v2/profiles/{profileId}/bookmarks/copy

用于将来源环境的书签复制到目标环境。路径中的 profileId 为目标环境 ID。

路径参数

名称	类型	必填	说明
profileId	string	是	目标环境 ID。

请求参数

名称	类型	必填	说明
source_profile_id	string	否	来源环境 ID。
include_settings	boolean	否	是否同时复制书签设置，默认 true。

请求示例

  -d '{
    "source_profile_id": "1876881021063852999",
    "include_settings": true
  }'

更新环境扩展设置

接口地址

PATCH /openapi/v2/profiles/{profileId}/extensions

用于更新指定环境的扩展管理模式和扩展分组。

路径参数

名称	类型	必填	说明
profileId	string	是	环境 ID。

请求参数

名称	类型	必填	说明
mode	string	否	扩展模式。可选值：allow、ban。
group_id	string	否	扩展分组 ID；传空表示不绑定扩展分组。

请求示例

  -d '{
    "mode": "allow",
    "group_id": "1876881021063852888"
  }'

查询扩展列表

接口地址

GET /openapi/v2/extensions

用于查询团队扩展列表。

查询参数

名称	类型	必填	说明
request	string	是	扩展列表查询参数。

响应参数

data.list 为扩展列表：

名称	类型	说明
id	string	扩展 ID。
name	string	扩展名称。
version	string	扩展版本。
source	string	扩展来源：local、google、dicloak。
groups	object[]	扩展所属分组列表。

通过 Chrome Web Store 链接添加扩展

接口地址

POST /openapi/v2/extensions

用于通过 Chrome Web Store 扩展详情页链接，将扩展添加到当前团队。添加成功后，可在扩展列表中查询，并可通过扩展分组绑定到环境。

当前仅支持 Chrome Web Store 详情页链接，不支持本地扩展包上传。

请求参数

名称	类型	必填	说明
url	string	是	Chrome Web Store 扩展详情页链接。
extension_group_ids	string[]	否	扩展分组 ID 列表；不传时自动使用默认扩展分组。
status	string	否	添加后的扩展状态。可选值：ENABLED、DISABLED；默认 DISABLED。
pin_type	string	否	扩展图标固定方式。可选值：CUSTOMIZE_PIN、PIN、UN_PIN；默认 CUSTOMIZE_PIN。
browser_hide	boolean	否	是否在浏览器中隐藏扩展图标，默认 false。
hide_role_id	string[]	否	隐藏扩展图标的角色 ID 列表；不传时默认 ["all"]。

请求示例

  -d '{
    "url": "https://chromewebstore.google.com/detail/simpleundoclose/plmkckmepaemlbdcihcfiffecmmnofil",
    "status": "DISABLED"
  }'

响应参数

data 为添加后的扩展信息：

名称	类型	说明
id	string	扩展记录 ID。
browser_extensions_id	string	扩展基础记录 ID 或扩展标识。
unique_id	string	Chrome Web Store 扩展 ID。
extensions_name	string	扩展名称。
extensions_introduce	string	扩展说明。
download_url	string	扩展安装包地址。
icon_url	string	扩展图标地址。
md5_hash	string	扩展包 MD5。
sha256_hash	string	扩展包 SHA256；未返回时为空字符串。
source	string	扩展来源，固定为 GOOGLE。
status	string	扩展状态：ENABLED、DISABLED。
version	string	扩展版本。
original_url	string	原始 Chrome Web Store 链接。
pin_type	string	扩展图标固定方式。
browser_hide	boolean	是否隐藏扩展图标。
hide_role_id	string[]	隐藏扩展图标的角色 ID 列表。
extension_group_ids	string[]	扩展所属分组 ID 列表。
already_exists	boolean	团队中是否已存在该扩展。
downloaded	boolean	本次请求是否执行了扩展包下载。

如果团队中已存在该扩展，接口会返回已有扩展信息，并将 already_exists 返回为 true。

查询扩展分组列表

接口地址

GET /openapi/v2/extension-groups

用于查询扩展分组列表。

查询参数

名称	类型	必填	说明
request	string	是	扩展分组列表查询参数。

响应参数

data.list 为扩展分组列表：

名称	类型	说明
id	string	扩展分组 ID。
name	string	扩展分组名称。
remark	string	备注。
created_at	string	创建时间。
updated_at	string	更新时间。

删除扩展

接口地址

DELETE /openapi/v2/extensions/{extensionId}

用于删除指定扩展。删除后使用该扩展的环境可能受到影响，请谨慎操作。

路径参数

名称	类型	必填	说明
extensionId	string	是	扩展 ID。