ویجت چت
تمام نقاط پایانی که ویجت چت تعبیهشده در وبسایتهای مشتریان استفاده میکند.
این گروه، تمام نقاط پایانی عمومی را که ویجت چت تعبیه شده در وبسایتهای مشتریان از آنها استفاده میکند، گرد هم میآورد: بررسی دسترسی (`GET /api/public/widget/health`)، دریافت پیکربندی عمومی ویجت (`GET /api/public/widget/config/:widget_code`)، و ارسال و مشاهده پیامها (`POST /api/public/widget/message`, `GET /api/public/widget/history`). مدیریت دامنه برای ایجاد ویجت توسط Zentor انجام میشود؛ برای این کار، هیچ رابط کاربری تنظیماتی در داشبورد مستاجر وجود ندارد. در صورت عدم اجازه دامنه، ممکن است کد خطای `WIDGET_ORIGIN_DENIED` نمایش داده شود. ایجاد ویجت فقط به مدیر اصلی اختصاص دارد، در حالی که مستاجر کد تعبیه آماده را دریافت میکند.
یک سیستم کلید API توسعهدهنده عمومی وجود ندارد. `health` و `config` بدون احراز هویت قابل دسترسی هستند، زیرا برای مقداردهی اولیه ویجت در مرورگر در نظر گرفته شدهاند. در مقابل، `message` و `history` به هدر `X-Widget-Token` نیاز دارند و علاوه بر این، در برابر لیست مجاز مبدأ سمت سرور بررسی میشوند. توکن تعبیه در هنگام ایجاد ویجت یک بار به صورت متن ساده نمایش داده میشود و نباید در مخازن عمومی، اسکرینشاتهای پشتیبانی یا لاگهای مرورگر ظاهر شود.
هر صفحه جزئیات این گروه، روش، مسیر، احراز هویت، عدم تکرارپذیری (Idempotency) و کدهای خطای مستند شده هر نقطه پایانی را به طور جداگانه شرح میدهد. یک فراخوانی موفقیتآمیز از یک نقطه پایانی، به طور خودکار تضمین نمیکند که یک نقطه پایانی دیگر از همان گروه نیز با موفقیت انجام شود. به طور خاص، یک بررسی `health` سبز، نه تنها یک ویجت معتبر را تأیید میکند، بلکه یک مبدأ مجاز یا دسترسی به یک ارائه دهنده هوش مصنوعی را نیز تضمین نمیکند.
حداکثر محدودیت API در سطح پلتفرم، 2000 درخواست در 15 دقیقه است. هرگونه محدودیت متفاوت برای یک نقطه پایانی ویجت خاص، فقط در صورتی ذکر میشود که به طور خاص برای آن نقطه پایانی تعیین شده باشد. `message` غیرقابل تکرارپذیری دارد؛ یک کلاینت نباید یک فرآیند ارسال ناموفق را به طور خودکار تکرار کند، مگر اینکه ابتدا بررسی کند که آیا پیام اول پردازش شده است یا خیر.
بررسی فنی این گروه بر اساس رجیستری موجود در `app/frontend/src/content/api-reference/groups/widget.ts` و مسیرهای بکاند مربوطه است. هر صفحه جزئیات نشان میدهد که آیا یک مسیر موفقیتآمیز، یک مسیر منفی یا فقط یک تجزیه و تحلیل کد بررسی شده است. این تمایز برای کل گروه معتبر است و نباید با اظهارات کلی موفقیت جایگزین شود.