reseller
POST /v1/reseller/brand/panel-hostname
Serve your clients' panel on your own address.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د reseller.manage اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.
چیرته چې ستاسو د سازمان آی ډي ځي
دا پای ټکی د پوښتنې پیرامیتر په توګه 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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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 agen… |
د غوښتنې بدن
| نوم | ډول | اړین | دا څه شی دی |
|---|---|---|---|
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 "pendi… |
تېروتنې چې دا پای ټکی یې بیرته راګرځولی شي
401 · 403 · 409 · 422 · 429 · 503