תיעוד API

תיעוד זה מתאר אך ורק נקודות קצה JSON אמיתיות וזמינות לשימוש ציבורי -- שיטה, נתיב, סוג אימות, פרמטרי חובה, דוגמת בקשה ותגובה, וקודי שגיאה מתועדים לכל נקודת קצה. ב-Zentor אין מערכת כללית של מפתחות API למפתחים; בהתאם לנתיב, הגישה מתבצעת ללא אימות או באמצעות טוקן הטמעה של הווידג'ט עם בדיקת Origin. נתיבי לוח בקרה פנימיים ונקודות קצה של Master Admin אינם נכללים בכוונה בתיעוד ציבורי זה, מאחר שניתן לגשת אליהם רק דרך סשן התחברות רגיל.

כל רשומת נקודת קצה כוללת הערת בדיקה חיה, המציינת אם המידע מקורו בסכמת הרישום, בבדיקה אוטומטית או בתצפית חיה בפועל -- דמיון בלבד לנתיב קוד עובד אינו נחשב הוכחה מלאה. בנוסף, קריאה שהצליחה מבחינה טכנית מאשרת תמיד רק את עיבוד הבקשה עצמה, ולא באופן אוטומטי תהליכים המשכיים כמו מסירת דוא"ל, השלמת תשלום או התחברות SSO שהושלמה.

רמת ההגנה תלויה בקבוצה. נקודות קצה ציבוריות של מידע משפטי, שיווק וטפסים אינן דורשות סשן של לוח הבקרה. וידג'ט הצ'אט, לעומת זאת, משתמש בכותרת `X-Widget-Token` וברשימת Origin מאושרים. התחברות ללוח הבקרה מספקת JWT של סשן בתוקף לשתים-עשרה שעות וטוקן רענון בתוקף לשבעה ימים. נקודות קצה של SSO פועלות עם קודים חד-פעמיים ותהליכי Callback משלהן.

קראו כל דף נקודת קצה כחוזה עצמאי. הגורמים המכריעים הם שיטת HTTP, נתיב, פרמטרי חובה, סוגי נתונים, גוף הבקשה, מבנה התגובה, קודי שגיאה ו-Idempotency. דוגמה מציגה פורמט אפשרי, אך אינה מחליפה בדיקה של התגובה בפועל. מצב התצורה, אימותי קלט, הרשאות וספקים חיצוניים עשויים לשנות את התוצאה.

מגבלת הקצב המאושרת לכל הפלטפורמה היא 2,000 בקשות בתוך 15 דקות. מגבלות נפרדות לכל נקודת קצה אינן מתועדות באופן עקבי. לכן לקוחות לא צריכים להשתמש בלולאות Polling צפופות שלא לצורך. בפעולות שאינן Idempotent, ניסיונות חוזרים אוטומטיים עלולים ליצור רשומות או הודעות כפולות.

ערכים רגישים אינם שייכים ללוגים. אלה כוללים סיסמאות, טוקני איפוס, קודי אימות, טוקני וידג'ט, מזהי סשן ונתוני דוגמה אישיים אמיתיים. השתמשו בערכים אנונימיים בתיעוד ובבדיקות. הערות בדיקה חיה חייבות לשקף נכונה את ההוכחה בפועל.