identity

GET /v1/branding/by-panel-hostname

The brand served on one panel hostname.

Todos os endpoints de identity

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/branding/by-panel-hostname?hostname=<hostname> \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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".

Parâmetros

NomeTipoObrigatórioO que é
hostname (query)stringSim

Resposta

NomeTipoObrigatórioO que é
namestringSim
logo_urlstringSim
primary_colourstringSim
support_urlstringSim
localesstring[]SimThe 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_localestringSimThe language the sign-in page opens in.
locales_restrictedbooleanSimTrue when the reseller narrowed the list.
language_switcherbooleanSimWhether the sign-in page should render a language picker at all.
currency_switcherbooleanSimWhether 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…
paletteobjectNãoThe 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_stackstringNãoA complete CSS `font-family` value, fallbacks included.
font_css_urlstringNãoThe self-hosted webfont stylesheet, from our own origin. Empty for a catalogue font.
nav_positionstringNão
densitystringNão
corner_radiusstringNão
colour_schemestringNão
favicon_urlstringNãoThe brand's icon, already falling back to its logo.
oidc_client_idstringSimThe 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_authoritystringSimWhere 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…

Erros que este endpoint pode retornar

404 · 429