reseller

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

Serve your clients' panel on your own address.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението reseller.manage; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.

ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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.

Параметри

Име	Тип	Задължително	Какво представлява
`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…

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`hostname`	`string`	Да	Just the hostname — `panel.acme.com`, with no scheme and no path. A hostname inside a domain Zinn® operates is refused.

Отговор

Име	Тип	Задължително	Какво представлява
`hostname`	`string`	Да	—
`active`	`boolean`	Да	Measured by fetching it, not read off the edge's status. See `ResellerBrand.panel_hostname_active`.
`provider_status`	`string`	Да	—
`records`	`BrandDnsRecord[]`	Да	—
`errors`	`string[]`	Не	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…

Грешки, които този крайpoint може да върне

401 · 403 · 409 · 422 · 429 · 503

POST /v1/reseller/brand/panel-hostname