identity

GET /v1/branding/by-panel-hostname

The brand served on one panel hostname.

すべての identity エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織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はい

返信

名前タイプ必須これがその内容です
namestringはい
logo_urlstringはい
primary_colourstringはい
support_urlstringはい
localesstring[]はい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_localestringはいThe language the sign-in page opens in.
locales_restrictedbooleanはいTrue when the reseller narrowed the list.
language_switcherbooleanはいWhether the sign-in page should render a language picker at all.
currency_switcherbooleanはい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…
paletteobjectいいえ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_stackstringいいえA complete CSS `font-family` value, fallbacks included.
font_css_urlstringいいえThe self-hosted webfont stylesheet, from our own origin. Empty for a catalogue font.
nav_positionstringいいえ
densitystringいいえ
corner_radiusstringいいえ
colour_schemestringいいえ
favicon_urlstringいいえThe brand's icon, already falling back to its logo.
oidc_client_idstringはい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_authoritystringはい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