reseller
GET /v1/reseller/brand
The identity your clients see.
પ્રમાણીકરણ
એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે 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.
પેરામીટર્સ
| નામ | પ્રકાર | જરૂરી | તે શું છે |
|---|---|---|---|
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