编辑器客户端 API 使用说明

一、适用场景

客户端 API 适合在局域网内把记乎编辑器接入自动化工具、脚本、内部系统或自定义制卡流程。它可以让外部程序访问编辑器中的牌组、模板、目录、卡牌和附件等数据。

普通用户不需要开启客户端 API。只有明确知道要用外部程序访问编辑器时，才建议启用。

二、启用方式

1. 打开记乎编辑器设置。
2. 进入“客户端 API”。
3. 开启“启用客户端 API”。
4. 记录页面显示的 API 访问地址和访问秘钥。

关闭开关后，外部程序将无法继续访问本机编辑器 API。

三、访问地址和秘钥

访问地址通常是局域网地址，只能在同一网络内访问。访问秘钥用于鉴权，外部程序请求接口时需要携带。

如果怀疑秘钥泄露，可以在设置页长按或打开秘钥操作并重置访问秘钥。重置后，旧秘钥会失效，外部程序需要更新配置。

四、接口能力

客户端 API 主要面向编辑器本地数据，常见能力包括：

• 登录和登出当前客户端会话。
• 触发全部同步或指定牌组同步。
• 查询、新建、更新和删除牌组。
• 查询、新建、更新和删除模板。
• 查询、新建、更新和删除目录。
• 搜索、查询、新建、更新和删除卡牌。
• 上传和删除卡牌资源文件。

具体接口字段以当前客户端 API 文档和应用版本为准。

五、安全建议

• 只在可信局域网中开启客户端 API。
• 不要把访问秘钥发给不可信的人或系统。
• 自动化脚本批量修改前，先备份或导出数据。
• 批量删除、覆盖卡牌或模板前，先在测试牌组验证。
• 不用时关闭客户端 API。

六、排查问题