احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/alerts/read \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "alert_keys": <string[]> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Clears the badge for these keys, for **this user only** — a colleague clearing the bell must not clear it for the rest of the team. ⚠️ **Read is not dismissed and not resolved.** An expired card that has been read is still expired, still listed and still red. Conflating the three would let a customer make a real problem *look* solved by opening a dropdown. Idempotent: the panel marks on open, and customers open it repeatedly.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id (query) | string | خیر | — |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
alert_keys | string[] | بله | The keys the panel actually rendered. ⛔ A list, never a "mark everything" boolean: an alert that arrived between the render and the click must NOT be marked seen, and a server-s… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 422 · 429