Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает 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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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… |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
data | Notice[] | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 429