reseller

POST `/v1/reseller/brand/panel-hostname`

Serve your clients' panel on your own address.

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation reseller.manage ; 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 POST https://api.zinndigital.com/v1/reseller/brand/panel-hostname \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "hostname": <string> }'

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

Registers a custom hostname at the edge and returns the DNS to publish. Requires `reseller.manage`. Your clients sign in at your address instead of ours — the address bar is what they look at on every single login, and it is the largest remaining piece of white-label. ⛔ Attaching does **not** make it live and changes no link we emit. Publish the `CNAME`, then call `/verify`. A hostname inside a domain Zinn® operates is refused with `422`, and a hostname is already attached ⇒ `409`.

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…

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`hostname`	`string`	Oui	Just the hostname — `panel.acme.com`, with no scheme and no path. A hostname inside a domain Zinn® operates is refused.

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`hostname`	`string`	Oui	—
`active`	`boolean`	Oui	Measured by fetching it, not read off the edge's status. See `ResellerBrand.panel_hostname_active`.
`provider_status`	`string`	Oui	—
`records`	`BrandDnsRecord[]`	Oui	—
`errors`	`string[]`	Non	The edge's own complaints, verbatim, on the verify response — "custom hostname does not CNAME to this zone" is a sentence a customer can act on in thirty seconds, where "pendi…

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 409 · 422 · 429 · 503