跳转到主要内容
GET
curl

概述

返回从您的 API 密钥解析出的应用的白标品牌设置,即终端用户在验证流程中看到的同一套品牌设置。响应包括颜色、字体、圆角半径、Logo URL 以及 UI/UX 选项。

使用场景

  • 读取当前主题:在渲染或编辑前,获取当前生效的调色板、字体和 Logo。
  • 同步品牌设置:将 Didit 的品牌设置同步到您自己的管理后台。

说明

  • 应用由 API 密钥确定,此接口没有路径参数或查询参数。
  • logo_square、logo_rectangular、logo_rectangular_dark、favicon 和 font_url 为只读字段。如需设置 Logo,请通过更新品牌设置上传图片。
  • logo_rectangular_dark 是深色模式下使用的矩形 Logo,显示在深色背景上。未设置深色 Logo,或您的账户不显示矩形 Logo 时,其值为 null。
  • 自定义域名和白标邮件不在此响应中返回;这两项仍需在 Business Console 中管理。

权限

API 密钥必须具有读取该应用定制配置的权限。

相关内容

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

响应

应用的当前品牌定制。

应用的白标品牌化:颜色、字体、圆角半径、徽标 URL 和 UI/UX 选项。徽标 URL 为只读(通过上传图片进行设置)。不包含自定义域名和白标邮件。

color_primary
string
color_secondary
string
color_background
string
color_panel
string
color_panel_10
string
color_on_panel_1
string
color_on_panel_2
string
color_on_background
string
color_button_1
string
color_button_2
string
color_button_text_1
string
color_button_text_2
string
color_pill_text
string
border_radius_panel
integer
border_radius_buttons
integer
font_family
string
font_weight
string
font_url
string | null

只读。所选字体系列解析后的 Google Fonts 样式表 URL。

logo_square
string | null

方形徽标的只读 URL。通过 image_square 上传。

logo_rectangular
string | null

矩形徽标的只读 URL。通过 image_rectangular 上传。

logo_rectangular_dark
string<uri> | null

只读。暗色模式矩形徽标的临时签名 URL,显示在深色背景上。当未设置暗色徽标或您的账户不显示矩形徽标时为 null。通过 image_rectangular_dark 上传。

favicon
string | null

网站图标的只读 URL。通过 image_favicon 上传。

app_public_name
string | null
privacy_policy_url
string | null
skip_welcome_screen
boolean
disable_login_with_didit
boolean
hide_progress_bar
boolean
callback_seconds
integer
最后修改于 2026年11月7日