תיעוד API

זוהי התיעוד של נקודות הקצה הזמינות של ה-API, אשר נבנו סביב ארכיטקטורת REST. כל נקודות הקצה של ה-API יחזירו תגובת JSON עם קודי תגובת HTTP סטנדרטיים וידרשו אותנטיקציית Bearer באמצעות מפתח API.

 

אימות

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

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

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "\u05d0\u05d9\u05df \u05dc\u05da \u05d2\u05d9\u05e9\u05d4 \u05dc-API.",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
כל תוצאות נקודות הקצה של ה-API פועלות לפי אזור הזמן UTC אלא אם צוין אחרת.
משתמש
קודי QR
ברקודים
קישורים
סטטיסטיקות קישור
פרויקטים
פיקסלים
דומיינים מותאמים אישית
תשלומי חשבון
יומני חשבון