Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте reseller.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде org_id мәнін қабылдайды. Оны бос қалдырсаңыз, шақыру бүкіл жалға алушы тармағын қамтиды; шақыруды бір ұйымға шектеу үшін оны жіберіңіз.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/reseller/brand \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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