Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде org_id мәнін қабылдайды. Оны бос қалдырсаңыз, шақыру бүкіл жалға алушы тармағын қамтиды; шақыруды бір ұйымға шектеу үшін оны жіберіңіз.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/notices \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
docs/87. What the platform is currently telling **this** customer, on **this** route, in **their** language — already sanitised, already localised. ⛔ No permission key. Reading the notices aimed at you is not a privilege: gating it would mean a member whose role happens to lack `org.read` never learns their card needs re-adding. The audience is the scope — a notice reaches an organization only if it is explicitly `everyone` or that org is named in its audience. An untargeted notice reaches nobody, never everybody. Exactly one of `body_html` and `body_i18n_key` is populated (a database constraint). `body_html` is operator-authored and safe to render as HTML; `body_i18n_key` + `body_params` are rendered from the SPA's own catalogue.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
route (query) | string | Жоқ | The dashboard path being rendered, e.g. `/billing/invoices`. Defaults to `/`. A query string is ignored, so a notice aimed at `/billing` does not vanish when the screen adds a tab. |
org_id (query) | string | Жоқ | Narrow to one organization. Omitted, the caller's whole accessible subtree is considered, so a reseller admin sees a notice aimed at a client org they manage. An id outside that… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
data | Notice[] | Иә | — |
Бұл соңғы нүкте қайтара алатын қателер
401 · 429