Xaqiijinta aqoonsiga
U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda mail.view; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.
Meesha aqoonsiga ururkaagu galayo
Endpoint-kani wuxතික org_id oo ah cabbir su'aal ah. Ka tag oo wicitaanku wuxuu daboolayaa dhammaan geedkaaga kiraynta; soo dir si aad wicitaanka ugu koobto hal urur.
Aqoonsiga ururkaagu wuxuu ku yaallaa shaashada furayaasha API ee dashboard-kaaga, oo ku xiga furaha laftiisa. Waa isku aqoonsi wicitaan kasta oo aad sameyso.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
curl -X GET https://api.zinndigital.com/v1/mail/services \
-H "Authorization: Bearer zdk_live_…"Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Details
Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
cursor (query) | string | Maya | Opaque cursor from a previous page's `page.next_cursor`. |
limit (query) | integer | Maya | Maximum items to return (page size). |
org_id (query) | Uuid | Maya | Restrict to one organization in scope. **Narrowing only** — the value is intersected with what the caller may already read, so an organization outside their subtree filters to n… |
fqdn (query) | string | Maya | Return only the service on this exact hostname (normalised: lowercased, trailing dot stripped). ⛔ **A site surface must use this rather than searching the list.** The list is pa… |
site_id (query) | string | Maya | Return only the mail services on the hostnames this **site** serves. Resolved through the site's domains, not through a stored column — mail attaches to a domain and a domain ou… |
worker_id (query) | string | Maya | Return only the mail services belonging to the sites on this **fleet worker**. Mail has no server of its own — it runs at the mail backend, not on the box serving the website —… |
compute_server_id (query) | string | Maya | As `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable. |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
data | MailService[] | Haa | — |
page | PageMeta | Haa | — |
Cilladaha ay bartaani soo celin karto
401 · 403 · 429