Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте reseller.view рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде 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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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