notices
GET /v1/notices
The notices to show at the top of this screen.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.
حيث يتم إدخال معرف مؤسستك
تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.
معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X GET https://api.zinndigital.com/v1/notices \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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