תיעוד API

למד כיצד להתחבר ולשלב עם ה-API שלנו.

 
קבל מפתח API משלך

אימות

כל נקודות הקצה של ה-API דורשות מפתח API שנשלח בשיטת Bearer Authentication.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

שגיאות

ה-API שלנו משתמש בקודי מצב HTTP קונבנציונליים כדי לציין הצלחה או כישלון של בקשה.

{
    "errors": [
        {
            "title": "\u05d0\u05d9\u05df \u05dc\u05da \u05d2\u05d9\u05e9\u05d4 \u05dc-API.",
            "status": 401
        }
    ]
}
200 הבקשה הושלמה בהצלחה
400 בקשה שגויה - פרמטרים נדרשים חסרים או לא חוקיים
401 לא מורשה - מפתח API חסר או לא חוקי
404 המשאב המבוקש לא נמצא
429 יותר מדי בקשות - חרגת ממגבלת התעריף
500 שגיאת שרת פנימית - זה אומר שיש בעיה בצד שלנו
כל תוצאות נקודות הקצה של API פועלות עם אזור הזמן UTC אלא אם צוין אחרת.
משתמש
צוותים
חברי צוות
חבר בצוותים
יומני חשבון