reseller

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

Serve your clients' panel on your own address.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) reseller.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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éterek

Név	Típus	Kötelező	Mi ez
`org_id (query)`	`Uuid`	Nem	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…

Kérés törzse

Név	Típus	Kötelező	Mi ez
`hostname`	`string`	Igen	Just the hostname — `panel.acme.com`, with no scheme and no path. A hostname inside a domain Zinn® operates is refused.

Válasz

Név	Típus	Kötelező	Mi ez
`hostname`	`string`	Igen	—
`active`	`boolean`	Igen	Measured by fetching it, not read off the edge's status. See `ResellerBrand.panel_hostname_active`.
`provider_status`	`string`	Igen	—
`records`	`BrandDnsRecord[]`	Igen	—
`errors`	`string[]`	Nem	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…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 409 · 422 · 429 · 503