認証
ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/reseller/brand \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Your brand as your clients see it — the name on their panel, the logo, the accent colour and the help links. Requires reseller.view. ⛔ A brand you have not set up yet is a 200 with configured: false, never a 404: the screen renders an empty form either way, and a 404 would make the app decide what "no brand" means. entitled reports whether white-label is on your plan at all.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
configured | boolean | はい | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | はい | Whether white-label is on this org's plan at all. |
name | string | はい | — |
logo_url | string | はい | — |
primary_colour | string | はい | — |
support_url | string | はい | — |
status_url | string | はい | — |
panel_hostname | string | はい | Read-only here — provisioned on /v1/reseller/brand/panel-hostname, because a hostname you merely typed is a link to nowhere on every client's screen. |
panel_hostname_active | boolean | はい | Whether the edge is actually serving it. ⛔ Measured, not the edge's status word: a custom hostname can be active with a valid certificate and still answer 522, so the engine… |
panel_hostname_status | string | はい | The edge's own status word, for display. Never branch on it. |
panel_hostname_records | BrandDnsRecord[] | はい | — |
sending_domain | string | はい | Read-only here — provisioned on /v1/reseller/brand/sending-domain, because an unverified domain does not deliver. |
sending_domain_verified | boolean | はい | Read-only. The mail provider's answer, not a setting. |
sending_domain_status | string | はい | The provider's own status word, for display. Never branch on it. |
sending_domain_records | BrandDnsRecord[] | はい | — |
palette | object | いいえ | Named design-system colour tokens, {token: "#rrggbb"}, over the closed set in palette_tokens. ⛔ Hex only, and that is a security boundary rather than a formatting rule: a CSS… |
font_source | string<catalogue, google, > | いいえ | catalogue for one of font_catalogue, google for a family we self-host. |
font_key | string | いいえ | The catalogue key when font_source is catalogue. |
font_google_family | string | いいえ | A Google family NAME, never a URL. ⛔ We fetch the family once, server-side, and serve the woff2 files from our own origin — so your clients never make a request to Google and… |
nav_position | string<side, top, > | いいえ | — |
density | string<comfortable, compact, > | いいえ | — |
corner_radius | string<soft, square, > | いいえ | — |
colour_scheme | string<system, light, dark, > | いいえ | The scheme a client's first visit lands on. ⛔ A default, never a lock — the panel's own theme toggle still works, because removing a visitor's dark mode is an accessibility… |
favicon_sha256 | string | いいえ | A favicon distinct from the panel logo. Upload it with POST /v1/branding/logo and purpose=favicon. Empty falls back to the logo — a 32px render of a wordmark beats somebody… |
favicon_url | string | いいえ | — |
email_logo_sha256 | string | いいえ | The mark used in transactional mail (purpose=email). Separate because the constraints differ: mail clients render on a light background whatever the reader's theme, block SVG,… |
email_logo_url | string | いいえ | — |
dns_nameservers | string[] | いいえ | Your own authoritative nameservers, so a client typing them into a registrar never reads ours. Empty means ours. ⛔ At least two, or none — registrars refuse a single… |
font_catalogue | object[] | いいえ | The typefaces you may pick, served with the value so a new one appears in your picker on deploy rather than when somebody remembers to update the app too. |
layout_options | object | いいえ | The allowed values for each layout choice, keyed by field name. |
palette_tokens | string[] | いいえ | The colour tokens palette may name. |
accent_contrast | BrandAccentContrast | いいえ | How readable your accent colour is, and the ink we will paint on it. ⚠️ Reported, never enforced. A legitimate corporate colour can be mid-grey, and refusing to save it would… |
このエンドポイントが返すエラー
401 · 403 · 404 · 429