品牌选项
Management API 在 KV 中存储七个组织作用域的品牌值。经过身份验证的管理客户端可以读取这些值;自动应用到 Hosted Auth 和电子邮件渲染尚未实现。
| 选项 | 描述 |
|---|---|
| 主色 | 为管理客户端保存的主色值。 |
| 背景色 | 为管理客户端存储页面背景值。 |
| 强调色 | 为管理客户端保存的强调色值。 |
| 圆角 | 保存的圆角值。API 不会将其限制为某个命名规格。 |
| 字体 | 存储的字体系列值。 API 不获取或验证远程字体。 |
| 徽标(浅色) | 存储的浅色主题徽标 URL。上传组织徽标是一个单独的 R2 支持端点。 |
| 徽标(深色) | 存储深色主题徽标 URL;此 API 不应用自动回退。 |
按组织的品牌配置
KV 中的每条记录均按租户和组织设键。记录不存在时,读取会返回全部七个字段且值为 null;这不代表运行时渲染或延迟方面的任何保证。
Management API 端点
使用 camelCase 字段名通过 PATCH 请求更新组织品牌。省略的字段和 null 目前都会保留已存储的值;如需更改字段,请发送替换字符串。
curl -X PATCH https://xid.dev/v1/organizations/org_xxx/branding \
-H 'Authorization: Bearer sk_live_xxx' \
-H 'Content-Type: application/json' \
-d '{
"primaryColor": "#6366f1",
"borderRadius": "0.5rem",
"fontFamily": "Inter, sans-serif",
"logoUrl": "https://cdn.example.com/logo.svg"
}'验证边界
- 品牌 schema 仅接受上面列出的七个字段,不接受自定义 CSS。
@import和url()CSS 处理未实现,因为端点不接受样式表。- 值存储为字符串;除了 JSON 类型之外,颜色、半径、字体和 URL 语法均不会进行验证。
- 没有 iframe 预览或单独的草稿和发布状态。
电子邮件模板边界
事务性电子邮件使用内置 Mustache 模板和全局 R2 语言包。尚未实现按组织上传 HTML 模板和自动注入品牌信息。