احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/reseller/services/{siteId} \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The same row `listResellerServices` returns, for one site. A site outside your client subtree is a 404, never a 403 — so this is not an existence oracle. Requires `reseller.view`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
org_id (query) | Uuid | خیر | Which of your organizations this applies to. Required only when you belong to more than one here. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
site_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | بله | — |
primary_domain | string | بله | — |
name | string | خیر | — |
status | SiteStatus | بله | A site's lifecycle state (docs/04 §3). A newly created site is `pending` until the provisioning workflow picks it up; `deleted` is terminal. `restricted` and `quarantined` are t… |
product_line | object | خیر | — |
plan_code | object | خیر | — |
plan_name | object | خیر | — |
held_by_reseller | boolean | خیر | True when the current suspension was placed through this surface, which is the only case `unsuspendResellerService` will release. A site suspended by the abuse desk reports fals… |
pending_deletion_at | object | خیر | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | خیر | What YOU charge for this plan, in minor units of `sell_currency` — your own price-list row if you have authored one, otherwise our list price with your default markup applied. N… |
sell_currency | object | خیر | — |
created_at | string | بله | — |
disk_used_bytes | object | خیر | Null when the hosting platform has no usage to report for this site. |
bandwidth_used_bytes | object | خیر | Outbound bandwidth this billing period, or null. |
usage_measured_at | object | خیر | When the reading was taken. Null alongside null usage — so "we have not measured this" is never mistaken for "it used nothing" (§2.44). |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429