identity
GET /v1/branding/by-panel-hostname
The brand served on one panel hostname.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X GET https://api.zinndigital.com/v1/branding/by-panel-hostname?hostname=<hostname> \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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".
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
hostname (query) | string | Ya | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
name | string | Ya | — |
logo_url | string | Ya | — |
primary_colour | string | Ya | — |
support_url | string | Ya | — |
locales | string[] | Ya | 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 | Ya | The language the sign-in page opens in. |
locales_restricted | boolean | Ya | True when the reseller narrowed the list. |
language_switcher | boolean | Ya | Whether the sign-in page should render a language picker at all. |
currency_switcher | boolean | Ya | 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 | Tidak | 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 | Tidak | A complete CSS `font-family` value, fallbacks included. |
font_css_url | string | Tidak | The self-hosted webfont stylesheet, from our own origin. Empty for a catalogue font. |
nav_position | string | Tidak | — |
density | string | Tidak | — |
corner_radius | string | Tidak | — |
colour_scheme | string | Tidak | — |
favicon_url | string | Tidak | The brand's icon, already falling back to its logo. |
oidc_client_id | string | Ya | 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 | Ya | 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… |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
404 · 429