运行时配置

在 Tiptap 协作中配置运行时设置，以通过 REST API 直接管理您的协作环境。

这些设置允许您在不重新启动应用程序的情况下，修改密钥、Webhook URL 等，特别是在适应项目需求或安全协议变化时。

设置概述

可以动态调整多个设置：

键	描述
`secret`	JWT 令牌密钥，首次启动时自动生成
`api_secret`	用于授权头的 API 密钥，首次启动时自动生成
`allowed_origins`	根据提供的值（以逗号分隔）验证 `Origin` 头，例如 `https://test.tiptap.dev,https://prod.tiptap.dev`；如果未设置，则禁用验证
`authentication_disabled`	设置为 `1` 以禁用身份验证，设置为 `0` 以启用（默认值：`0`）
`webhook_url`	用于接收 webhook 回调的 URL
`webhook_loader_url`	可选的 webhook URL，用于初始加载文档。有关更多信息，请参见 webhooks。
`webhook_version`	Webhook 的版本
`webhook_awareness`	启用用户活动的意识 webhook，跟踪 `user.connected` 和 `user.disconnected` 事件（`1` 为启用，`0` 为禁用）
`webhook_log_errors_only`	仅记录 webhook 错误；成功的 webhook 日志被禁用
`default_auto_versioning`	设置为 `1` 以启用自动版本控制，设置为 `0` 以禁用（默认值：`0`）
`default_auto_versioning_interval`	自动版本控制的时间间隔（以秒为单位，默认值：`30` 秒）
`auto_versioning_all_fragments`	设置为 `1` 以使自动版本控制监听文档的任何片段/字段的更改（默认值仅为 `default`）
`name`	用于标识的实例名称

通过 API 管理设置

协作平台提供了一个简单的 API 来管理这些设置。将 :key 替换为您希望更新的设置键。

创建或覆盖设置

使用此调用添加或更新设置：

curl --location --request PUT 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA' --header 'Content-Type: text/plain' \
-d 'your value'

列出当前设置

使用此调用检索所有当前设置的列表：

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

检索特定设置

使用此调用检索特定设置的值：

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

删除设置

使用此调用删除设置：

curl --location --request DELETE 'https://YOUR_APP_ID.collab.tiptap.cloud/api/admin/settings/:key' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'

服务器性能指标

使用 /api/statistics 端点收集服务器性能数据，包括文档总数、峰值并发连接、过去 30 天的总连接数以及生命周期连接计数。有关更多信息，请查看指标页面。

curl --location 'https://YOUR_APP_ID.collab.tiptap.cloud/api/statistics' \
--header 'Authorization: YOUR_SECRET_FROM_SETTINGS_AREA'