reseller
GET /v1/reseller/brand
The identity your clients see.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی 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.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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