SMSBAT ChatHub API

ChatHub REST API מנהל צ’אטים עסקיים של Viber, שיחות עם לקוחות וזרימות עבודה של אוטומציה של תמיכת לקוחות.

כתובת האתר הבסיסית

https://chatapi.smsbat.com

תיעוד Swagger

תיעוד API אינטראקטיבי זמין בכתובת:

https://chatapi.smsbat.com/index.html

אימות

ChatHub משתמש במערכת אימות מבוססת Token Bearer עם אסימוני JWT. ניתן להעביר אסימונים בשתי דרכים:

שיטה 1: כותרת הרשאה

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer your-jwt-token"

שיטה 2: X-Authorization-Key Header

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: your-jwt-token"

זרימת אימות

ChatHub משתמש במערכת אסימונים דו-מפלסית:

1. אסימון חברה - אסימון גישה ברמת הארגון
2. אסימון מפעיל - אסימון גישה למפעיל בודד

זרימת עבודה

graph LR
    A[Get Company Token] --> B[List Organizations]
    B --> C[List/Add Operators]
    C --> D[Get Operator Token]
    D --> E[Integrate Widget]

נקודות קצה עיקריות

שיטה	נקודת קצה	תיאור
פוסט	/api/company/get-token	השג אסימון הרשאת חברה
קבל	/api/company/organization	אחזר רשימת ארגונים
קבל	/api/operator	רשימת מפעילים לפי ארגון
פוסט	/api/operator/synchronize	הוסף אופרטורים חדשים
פוסט	/api/operator/status	שנה סטטוס מפעיל
פוסט	/api/operator/get-token	צור אסימוני מפעיל (תפוגה מקסימלית של 24 שעות)
פוסט	/api/operator/validate-token	אימות תוקף האסימון

תכונות עיקריות

ניהול אסימוני חברה

השג ונהל אסימונים ברמת הארגון לגישה ל-API.

ניהול ארגון

• רשום את כל הארגונים
• אחזר פרטי ארגון
• ניהול הגדרות הארגון

ניהול מפעיל

• רשימת מפעילים לפי ארגון
• הוסף אופרטורים חדשים
• שנה סטטוס מפעיל (פעיל/לא פעיל/נמחק)
• צור אסימונים ספציפיים למפעיל (מקסימום 24 שעות)
• אימות אסימוני מפעיל

שילוב ווידג’טים

שלב ווידג’ט של ChatHub ביישומי אינטרנט לתמיכת לקוחות בזמן אמת.

התחלה מהירה

1. אימות - קבל את אסימוני החברה והמפעיל שלך
2. ארגונים - נהל ארגונים
3. מפעילים - הוסף ונהל אופרטורים
4. שילוב ווידג’ט - שילוב ווידג’ט של צ’אט

פורמט בקשה

כל הבקשות משתמשות בפורמט JSON:

{
  "login": "your-login",
  "password": "your-password"
}

פורמט תגובה

תגובות מוצלחות חוזרות:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-01-24T12:00:00Z"
}

טיפול בשגיאות

קודי מצב HTTP:

• 200 בסדר - הבקשה הצליחה
• 400 בקשה שגויה - פורמט בקשה לא חוקי
• 401 לא מורשה - האימות נכשל
• 403 אסור - הרשאות לא מספיקות
• 404 לא נמצא - משאב לא נמצא
• 500 שגיאת שרת פנימית - שגיאת שרת

תפוגת אסימון

לאסימונים יש זמן תפוגה. כאשר תוקף אסימון יפוג:

1. ה-API יחזיר ‘401 לא מורשה’
2. בקש אסימון חדש באמצעות נקודת הקצה של האימות
3. עדכן את האפליקציה שלך עם האסימון החדש

השלבים הבאים

• אימות - למד כיצד לבצע אימות
• ארגונים - ניהול ארגונים
• מפעילים - עבודה עם אופרטורים
• שילוב יישומון - שלב את ווידג’ט הצ’אט