设置与协作
连接其他软件
用 API 密钥获取访问权限,用 Webhook 接收更新通知。
什么时候需要集成?
当脚本、机器人或其他系统需要与 2novel 协作时,请使用“集成”。在应用内翻译和编辑不需要 API 密钥或 Webhook。
创建 2novel API 密钥
前往“设置 → 集成 → 2novel API 密钥”。能否使用取决于你工作区的权限。
- 创建密钥,并以使用它的软件来命名。
- 在仅显示一次的页面复制密钥,并保存到密钥管理工具或私有的接收端配置中。切勿放进公开的前端代码。
- 参考 API 文档发起经过身份验证的请求。
- 撤销不再使用的密钥。如果密钥丢失,请创建新的;旧密钥的明文无法再次查看。
接收 Webhook 通知
Webhook 只通知某部作品有更新,不包含完整的章节文本。你的接收端需要通过 API 获取所需的数据。
- 打开“Webhook 通知”,注册一个你可控的公开 HTTPS 端点。
- 选择接收端需要的事件。
- 保存仅显示一次的签名密钥,并在接收端配置签名验证。
- 发送一次测试,检查响应码并查看接收端日志。仅有成功响应,并不能证明签名验证已生效。
- 监控投递状态。维护期间暂停,接收端准备好后再恢复。
轮换密钥并恢复投递
轮换签名密钥后,接收端必须使用新密钥,请及时更新。删除 Webhook 会停止之后的投递。关于基于原始请求体的签名验证和响应处理,请参考 API 文档。