المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.
حيث يتم إدخال معرف مؤسستك
تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.
معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X GET https://api.zinndigital.com/v1/branding \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API
التفاصيل
The name, logo, colour and links the signed-in customer's dashboard paints itself with — their agency's or reseller's if they are white-labelled, otherwise Zinn®'s. **Always answers, for every authenticated caller.** An organisation with no brand of its own is not a `404`: it receives the platform identity with `is_white_label: false`. A nullable answer would make every client invent its own fallback, and the second such client is the leak this feature exists to close. Resolved by walking **up** the organisation tree to the org that owns the brand, and gated on the `white_label` entitlement held by that owner — never by the client reading it, who holds no such entitlement and never will. ⛔ Not gated on a permission key. This answers *"what does your screen look like?"*, not *"may you see this data?"* — the payload is the brand the caller is already looking at. It is still authenticated and org-scoped, so one tenant cannot ask what another tenant's panel looks like. **`Cache-Control: private, no-store`** — this response is never stored, by any cache, and that is a tenancy requirement rather than a tuning choice. The URL is `/v1/branding` for every tenant and the organisation travels in `X-Zinn-Org`, so a stored copy is keyed on nothing that separates one tenant from the next. It was `private, max-age=60` until 2026-08-26; `private` bounds a stored copy to one browser profile and **does not** bound it to one tenant, and one browser profile is exactly where an organisation switch happens. Measured before the change: four organisations, one token, one second apart, all four answering with the first one's brand. `Vary: X-Zinn-Org, Authorization` is sent as well, so an intermediary that stores despite `no-store` still cannot serve one tenant's brand to another.
المعلمات
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
org_id (query) | string | لا | Which of the caller's organisations to resolve for. Optional, and only needed by a person who belongs to several. `X-Zinn-Org` stands in for it when it is absent. Accepts **any… |
الاستجابة
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
name | string | نعم | The name shown in the page title, the sidebar header and the browser tab. |
dashboard_url | string | نعم | Where this brand's panel lives. The brand's own attached hostname when it has one, otherwise the platform panel — never a hostname that does not resolve yet, because a link the… |
support_url | string | نعم | — |
status_url | string | نعم | — |
logo_url | string | نعم | Empty when the brand has set no logo; the client then renders the name. |
primary_colour | string | نعم | Empty when the brand has set no colour; the client then uses its default. |
is_white_label | boolean | نعم | `false` for Zinn®'s own identity. Lets a surface say "this is white-labelled" without comparing the name to a literal. |
is_client_of_reseller | boolean | نعم | `true` only when this brand belongs to an organisation **above** yours — that is, you are a reseller's client rather than the reseller. ⛔ Not the same question as `is_white_labe… |
locales | string[] | نعم | The languages this panel may be shown in, in registry order. Every language we ship, unless the caller is a reseller's client and that reseller narrowed the list. Never empty. S… |
default_locale | string | نعم | The language a new account under this brand starts in. Always a member of `locales`. |
locales_restricted | boolean | نعم | `true` when a reseller narrowed the list, so a surface can explain why a language is missing instead of looking broken. |
language_switcher | boolean | نعم | `false` when the reseller has removed the language control from their clients' panel. Render no picker — not a disabled one. `locales` stays populated regardless: hiding a contr… |
currencies | string[] | نعم | The currencies this panel may quote in, in registry order. Every currency we can charge, unless the caller is a reseller's client and that reseller narrowed the list. Never empty. |
default_currency | string | نعم | What a viewer under this brand is quoted in before they choose. Always a member of `currencies`. |
currencies_restricted | boolean | نعم | `true` when a reseller narrowed the list, so a surface can explain why a currency is missing instead of looking broken. |
currency_switcher | boolean | نعم | `false` when the reseller has removed the currency control. Every client of that reseller is then quoted in `default_currency`. |
palette | object | نعم | Design-system colour tokens the brand chose, `{token: "#rrggbb"}`. **Empty for the platform**, which means *"use the design system's own"* — expressed as absence rather than as… |
font_stack | string | نعم | A complete CSS `font-family` value, fallbacks included. Never a bare family name: a brand whose webfont fails to load must land somewhere chosen, not on the browser's default se… |
font_css_url | string | نعم | A stylesheet installing a self-hosted Google family, or `""` for a catalogue font that needs no bytes. ⛔ Served from **our** origin, never `fonts.googleapis.com`. A `<link>` to… |
nav_position | string | نعم | — |
density | string | نعم | — |
corner_radius | string | نعم | — |
colour_scheme | string | نعم | The scheme a first visit lands on. |
favicon_url | string | نعم | The brand's icon, already falling back to its logo. Empty means *"leave whatever the surface has"* — never our mark, because on a reseller's hostname that is the leak. |
email_logo_url | string | نعم | The mark for transactional mail; falls back to the panel logo. |
menu_items | BrandNavLink[] | نعم | Custom navigation links the provider added, **already filtered** to what this reader may see. |
الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه
401 · 429