Doğrulama
API açarını bearer token kimi göndərin. Açar sites.view icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/domains \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
The registered/connected domains in scope. Cursor-paginated, RLS-scoped. Requires `sites.view`.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
X-Zinn-Org (header) | string | Xeyr | **Which organisation this call acts for.** Send a client organisation's id and every org-scoped endpoint answers for that client alone; omit it and the answer covers everything… |
cursor (query) | string | Xeyr | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Xeyr | Maximum items to return (page size). |
status (query) | DomainStatus | Xeyr | Filter by domain lifecycle status. |
org_id (query) | Uuid | Xeyr | Restrict to one organization in scope. |
tld (query) | string | Xeyr | Filter by TLD (e.g. `com`). |
site_id (query) | Uuid | Xeyr | Restrict to the domain backing one site — the link a site's DNS screen follows to reach the zone it should edit. Scoped by the same RLS filter as everything else here, so a site… |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
data | Domain[] | Bəli | — |
page | PageMeta | Bəli | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 422 · 429