Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/reseller/brand \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
org_id (query) | Uuid | Non | 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… |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
configured | boolean | Oui | Whether a brand row exists yet. False renders an empty form, not a 404. |
entitled | boolean | Oui | Whether white-label is on this org's plan at all. |
name | string | Oui | — |
logo_url | string | Oui | — |
primary_colour | string | Oui | — |
support_url | string | Oui | — |
status_url | string | Oui | — |
panel_hostname | string | Oui | 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 | Oui | 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 | Oui | The edge's own status word, for display. Never branch on it. |
panel_hostname_records | BrandDnsRecord[] | Oui | — |
sending_domain | string | Oui | Read-only here — provisioned on `/v1/reseller/brand/sending-domain`, because an unverified domain does not deliver. |
sending_domain_verified | boolean | Oui | Read-only. The mail provider's answer, not a setting. |
sending_domain_status | string | Oui | The provider's own status word, for display. Never branch on it. |
sending_domain_records | BrandDnsRecord[] | Oui | — |
palette | object | Non | 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, > | Non | `catalogue` for one of `font_catalogue`, `google` for a family we self-host. |
font_key | string | Non | The catalogue key when `font_source` is `catalogue`. |
font_google_family | string | Non | 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, > | Non | — |
density | string<comfortable, compact, > | Non | — |
corner_radius | string<soft, square, > | Non | — |
colour_scheme | string<system, light, dark, > | Non | 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 | Non | 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 | Non | — |
email_logo_sha256 | string | Non | 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 | Non | — |
dns_nameservers | string[] | Non | 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[] | Non | 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 | Non | The allowed values for each layout choice, keyed by field name. |
palette_tokens | string[] | Non | The colour tokens `palette` may name. |
accent_contrast | BrandAccentContrast | Non | 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… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429