תיעוד API

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

 

אימות

כל בקשות ה-API דורשות אימות באמצעות מפתח API הנשלח דרך כותרת Authorization, כפי שמוצג להלן.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://tistos.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, אלא אם צוין אחרת.
משתמש
קישורים
סטטיסטיקות קישורים
פרויקטים
פיקסלים
דפי Splash
קודי QR
נתונים
מטפלי התראות
דומיינים מותאמים אישית
צוותים
חברי צוות
חבר צוות
תשלומי חשבון
יומני חשבון