Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin reseller.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Tempat ID organisasi Anda dimasukkan
Titik akhir ini menerima org_id sebagai parameter kueri. Kosongkan parameter tersebut dan panggilan ini akan mencakup seluruh subpohon penyewa Anda; kirimkan untuk mempersempit panggilan ke satu organisasi.
ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.
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/reseller/brand \
-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
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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
org_id (query) | Uuid | Tidak | 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… |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
configured | boolean | Ya | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | Ya | Whether white-label is on this org's plan at all. |
name | string | Ya | — |
logo_url | string | Ya | — |
primary_colour | string | Ya | — |
support_url | string | Ya | — |
status_url | string | Ya | — |
panel_hostname | string | Ya | 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 | Ya | 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 | Ya | The edge's own status word, for display. Never branch on it. |
panel_hostname_records | BrandDnsRecord[] | Ya | — |
sending_domain | string | Ya | Read-only here — provisioned on `/v1/reseller/brand/sending-domain`, because an unverified domain does not deliver. |
sending_domain_verified | boolean | Ya | Read-only. The mail provider's answer, not a setting. |
sending_domain_status | string | Ya | The provider's own status word, for display. Never branch on it. |
sending_domain_records | BrandDnsRecord[] | Ya | — |
palette | object | Tidak | 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, > | Tidak | `catalogue` for one of `font_catalogue`, `google` for a family we self-host. |
font_key | string | Tidak | The catalogue key when `font_source` is `catalogue`. |
font_google_family | string | Tidak | 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, > | Tidak | — |
density | string<comfortable, compact, > | Tidak | — |
corner_radius | string<soft, square, > | Tidak | — |
colour_scheme | string<system, light, dark, > | Tidak | 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 | Tidak | 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 | Tidak | — |
email_logo_sha256 | string | Tidak | 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 | Tidak | — |
dns_nameservers | string[] | Tidak | 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[] | Tidak | 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 | Tidak | The allowed values for each layout choice, keyed by field name. |
palette_tokens | string[] | Tidak | The colour tokens `palette` may name. |
accent_contrast | BrandAccentContrast | Tidak | 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… |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 429