עימוד
ה-endpoint הרשימתיים של ה-API מחזירים נתונים בדפים. בפלטפורמה קיימות שתי שיטות עימוד; השיטה הספציפית מצוינת ב-endpoint בתיעוד האינטראקטיבי.
שיטה 1 — היסט ו-X-Total-Count
עימוד קלאסי לפי היסט. הבקשה מקבלת פרמטרי query: limit (גודל דף) ו-offset (כמה רשומות לדלג):
curl -H "Authorization: Bearer mbp_הטוקן_שלך" "https://הדומיין-שלך/api/bots/BOT_ID/subscribers?limit=50&offset=100"
הספירה הכוללת מוחזרת בכותרת תגובה X-Total-Count. לפיה מחשבים את מספר הדפים: דפדפו תוך הגדלת offset ב-limit, כל עוד offset קטן מערך X-Total-Count. גוף התגובה הוא מערך של רכיבי הדף הנוכחי.
שיטה 2 — סמן before ו-has_more
עימוד מבוסס סמן לפידים המסודרים לפי זמן (לדוגמה, הודעות דיאלוג). הבקשה מקבלת limit וסמן אופציונלי before — מזהה או סמן של הרכיב האחרון שהתקבל:
curl -H "Authorization: Bearer mbp_הטוקן_שלך" "https://הדומיין-שלך/api/bots/BOT_ID/users/USER_ID/dialog?limit=50&before=CURSOR"
התגובה מכילה דף רכיבים ודגל has_more. כל עוד has_more הוא true, חזרו על הבקשה תוך העברת סמן הרכיב האחרון שהתקבל ב-before. כשיהיה has_more שווה false — זהו הדף האחרון.
איזו שיטה לבחור
אינכם בוחרים שיטה — ה-endpoint קובע אותה. רשימות-עזר בדרך כלל משתמשות בהיסט ו-X-Total-Count; פידים לפי זמן — בסמן before ו-has_more. תמיד בדקו בדף ה-endpoint בתיעוד.
המשך
- התחלה מהירה עם API — בקשות ראשונות.
- שגיאות — קודי מצב.
- מגבלות וגדלים — מגבלות בקשות.