身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/branding/by-panel-hostname?hostname=<hostname> \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
The brand behind a reseller's own panel address. ⛔ **Unauthenticated, deliberately, and this is the only endpoint on the API where that is the right answer.** Its caller is the edge Worker rendering a *maintenance page* — which by definition runs when the panel behind it is unreachable, quite possibly because the engine is having a bad time. A credential to fetch would be one more thing to go wrong on the error path, and the Worker has nobody to authenticate as. ⭐ It discloses nothing new: it answers **only for a hostname that is already actively serving that brand's panel**, so everything in the payload is on the screen of anyone who types that address. An unknown or inactive hostname is a `404` with no detail, so it is not an oracle for "which of these domains is a Zinn® customer".
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
hostname (query) | string | 是 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
name | string | 是 | — |
logo_url | string | 是 | — |
primary_colour | string | 是 | — |
support_url | string | 是 | — |
locales | string[] | 是 | The languages this panel offers, so the **sign-in page** can be in one of them. A reseller selling into one market should not have their customers meet an English login form and… |
default_locale | string | 是 | The language the sign-in page opens in. |
locales_restricted | boolean | 是 | True when the reseller narrowed the list. |
language_switcher | boolean | 是 | Whether the sign-in page should render a language picker at all. |
currency_switcher | boolean | 是 | Whether a currency picker should render. No `currencies` list rides on this response: a maintenance or sign-in page prices nothing, so the list would be dead weight on a respons… |
palette | object | 否 | The brand's colour tokens, so the **logged-out** sign-in card can paint itself. ⚖️ The owner asked directly on 2026-09-03 whether a visitor sent to a login from a members-only p… |
font_stack | string | 否 | A complete CSS `font-family` value, fallbacks included. |
font_css_url | string | 否 | The self-hosted webfont stylesheet, from our own origin. Empty for a catalogue font. |
nav_position | string | 否 | — |
density | string | 否 | — |
corner_radius | string | 否 | — |
colour_scheme | string | 否 | — |
favicon_url | string | 否 | The brand's icon, already falling back to its logo. |
oidc_client_id | string | 是 | The Keycloak client this panel signs in through. ⛔ The panel cannot sign anybody in without it. One build of the dashboard is served on `app.zinndigital.com` and on every resell… |
oidc_authority | string | 是 | Where this panel's browser fetches OIDC metadata from — the reseller's **own** hostname, not ours. ⛔ **This is what keeps our name out of the address bar during sign-in** (#2990… |
此端点可能返回的错误
404 · 429