Doğrulama
API açarını bearer token kimi göndərin. Açar reseller.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/reseller/brand \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
org_id (query) | Uuid | Xeyr | 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 agen… |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
configured | boolean | Bəli | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | Bəli | Whether white-label is on this org's plan at all. |
name | string | Bəli | — |
logo_url | string | Bəli | — |
primary_colour | string | Bəli | — |
support_url | string | Bəli | — |
status_url | string | Bəli | — |
panel_hostname | string | Bəli | 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 | Bəli | 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 engi… |
panel_hostname_status | string | Bəli | The edge's own status word, for display. Never branch on it. |
panel_hostname_records | BrandDnsRecord[] | Bəli | — |
sending_domain | string | Bəli | Read-only here — provisioned on `/v1/reseller/brand/sending-domain`, because an unverified domain does not deliver. |
sending_domain_verified | boolean | Bəli | Read-only. The mail provider's answer, not a setting. |
sending_domain_status | string | Bəli | The provider's own status word, for display. Never branch on it. |
sending_domain_records | BrandDnsRecord[] | Bəli | — |
palette | object | Xeyr | 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 CS… |
font_source | string<catalogue, google, > | Xeyr | `catalogue` for one of `font_catalogue`, `google` for a family we self-host. |
font_key | string | Xeyr | The catalogue key when `font_source` is `catalogue`. |
font_google_family | string | Xeyr | 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 th… |
nav_position | string<side, top, > | Xeyr | — |
density | string<comfortable, compact, > | Xeyr | — |
corner_radius | string<soft, square, > | Xeyr | — |
colour_scheme | string<system, light, dark, > | Xeyr | 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 | Xeyr | 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 | Xeyr | — |
email_logo_sha256 | string | Xeyr | 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 | Xeyr | — |
dns_nameservers | string[] | Xeyr | 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 nameser… |
font_catalogue | object[] | Xeyr | 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 | Xeyr | The allowed values for each layout choice, keyed by field name. |
palette_tokens | string[] | Xeyr | The colour tokens `palette` may name. |
accent_contrast | BrandAccentContrast | Xeyr | 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 woul… |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 429