Autentifikimi
Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.
Ku shkon id i organizatës suaj
Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.
ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X GET https://api.zinndigital.com/v1/site-groups \
-H "Authorization: Bearer zdk_live_…"Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
Every group in scope with its member count, plus whether this caller's plan lets them create one and the colours a group may be drawn in. Gated on `sites.view` — a group is a view of sites the caller can already see.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
org_id (query) | string | Jo | Narrow to one organisation in the caller's subtree — what the dashboard's org switcher sends. ⛔ **Narrow only:** intersected with what the caller may already read, so an org out… |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
items | SiteGroup[] | Po | — |
can_create | boolean | Po | Whether any organisation in scope sells `site_groups`. The screen renders the create control as ABSENT rather than disabled when this is false — an inert button that never expla… |
colours | string[] | Po | — |
Gabimet që ky pikëndalim mund të kthejë
401 · 403