identity
GET /v1/branding/by-panel-hostname
The brand served on one panel hostname.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/branding/by-panel-hostname?hostname=<hostname> \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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