reseller
GET /v1/reseller/brand
The identity your clients see.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි reseller.view අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්රතික්ෂේප කෙරේ.
ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය
මෙම අවසාන ලක්ෂ්යය (endpoint) විමසුම් පරාමිතියක් ලෙස org_id ලබා ගනී. එය ඉවත් කළ විට ඇමතීම ඔබේ මුළු කුලී උප වෘක්ෂය (tenancy subtree) ආවරණය කරයි; ඇමතීම එක් සංවිධානයකට පමණක් සීමා කිරීමට එය යවන්න.
ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්රතිස්ථාපනය කරන්න.
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… |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
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