reseller
GET /v1/reseller/overview
Everything you have — every URL, credential and setting, in one read.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/reseller/overview \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The reseller reference card: the address your clients sign in at, the nameservers you hand them, your sending domain, your API base and key counts, where your clients' support goes, which product lines you sell, how many languages their panel offers, and how many client accounts you run. Every block carries the route that changes it, and the gaps (`gateway_gap`, `invoicing_gap`, `support.gap`) are reported as booleans so a screen can say what is missing rather than render a blank field. Requires `reseller.view`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | Uuid | خیر | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
program | ResellerOverviewProgram | بله | — |
panel | ResellerOverviewPanel | بله | — |
mail | ResellerOverviewMail | بله | — |
dns | ResellerOverviewDns | بله | — |
api | ResellerOverviewApi | بله | — |
support | ResellerOverviewSupport | بله | — |
commerce | ResellerOverviewCommerce | بله | — |
languages | ResellerOverviewLanguages | بله | — |
notifications | ResellerOverviewNotifications | بله | — |
clients | ResellerOverviewClients | بله | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429