مرجع API

این مرجع فقط نقاط پایانی JSON واقعی و قابل استفاده عمومی را شرح می‌دهد -- متد، مسیر، نوع احراز هویت، پارامترهای الزامی، نمونه درخواست و پاسخ و کدهای خطای مستندشده برای هر نقطه پایانی. Zentor سیستم عمومی کلید API برای توسعه‌دهندگان ندارد؛ دسترسی بسته به مسیر یا بدون احراز هویت است یا از طریق توکن جاسازی ویجت همراه با بررسی Origin. مسیرهای داخلی داشبورد و نقاط پایانی Master Admin عمداً بخشی از این مرجع عمومی نیستند، زیرا فقط از طریق نشست ورود عادی در دسترس‌اند.

هر مدخل نقطه پایانی یک یادداشت آزمون زنده دارد که مشخص می‌کند اطلاعات از طرح‌واره رجیستری، یک آزمون خودکار یا مشاهده زنده واقعی به دست آمده است -- صرف شباهت به یک مسیر کد کارا، اثبات کامل به شمار نمی‌آید. افزون بر این، یک فراخوانی موفق از نظر فنی همواره فقط پردازش خودِ همان درخواست را تأیید می‌کند، نه به‌طور خودکار فرایندهای بعدی مانند تحویل ایمیل، تکمیل پرداخت یا ورود کامل از طریق SSO را.

نحوه حفاظت به گروه مربوط بستگی دارد. نقاط پایانی عمومی حقوقی، بازاریابی و فرم به نشست داشبورد نیاز ندارند. در مقابل، ویجت چت از هدر `X-Widget-Token` و فهرست Originهای مجاز استفاده می‌کند. ورود به داشبورد یک JWT نشست با اعتبار دوازده ساعت و یک توکن تازه‌سازی (Refresh Token) با اعتبار هفت روز صادر می‌کند. نقاط پایانی SSO با کدهای یک‌بارمصرف و فرایندهای callback مخصوص خود کار می‌کنند.

هر صفحه نقطه پایانی را به‌عنوان یک قرارداد مستقل بخوانید. متد HTTP، مسیر، پارامترهای الزامی، انواع داده، بدنه درخواست، ساختار پاسخ، کدهای خطا و خودتوانی (idempotency) تعیین‌کننده‌اند. نمونه یک قالب ممکن را نشان می‌دهد، اما جایگزین بررسی پاسخ واقعی نیست. وضعیت پیکربندی، اعتبارسنجی‌ها، مجوزها و ارائه‌دهندگان خارجی می‌توانند نتیجه را تغییر دهند.

محدودیت نرخ تأییدشده در کل پلتفرم ۲٬۰۰۰ درخواست در ۱۵ دقیقه است. محدودیت‌های جداگانه برای هر نقطه پایانی به‌طور یکپارچه مستند نشده‌اند. بنابراین کلاینت‌ها نباید از حلقه‌های polling بی‌جهت فشرده استفاده کنند. در عملیات غیرخودتوان، تکرارهای خودکار ممکن است رکوردها یا پیام‌های تکراری ایجاد کنند.

مقادیر حساس نباید در لاگ‌ها ثبت شوند. این شامل گذرواژه‌ها، توکن‌های بازنشانی، کدهای تأیید، توکن‌های ویجت، شناسه‌های نشست و داده‌های نمونه شخصی واقعی است. در مستندات و آزمون‌ها از مقادیر ناشناس‌سازی‌شده استفاده کنید. یادداشت‌های آزمون زنده باید اثبات واقعی را به‌درستی منعکس کنند.