SMSBAT ChatHub API

ChatHub REST API მართავს Viber-ის ბიზნეს ჩეთებს, კლიენტებთან საუბრებს და მომხმარებელთა მხარდაჭერის ავტომატიზაციის სამუშაო პროცესებს.

საბაზისო URL

https://chatapi.smsbat.com

Swagger დოკუმენტაცია

ინტერაქტიული API დოკუმენტაცია ხელმისაწვდომია:

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

ავტორიზაცია

ChatHub იყენებს 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. Company Token - ორგანიზაციის დონის წვდომის ნიშანი
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/კომპანია/get-token	კომპანიის ავტორიზაციის ჟეტონის მიღება
მიიღეთ	/api/კომპანია/ორგანიზაცია	ორგანიზაციის სიის აღდგენა
მიიღეთ	/api/ოპერატორი	ჩამოთვალეთ ოპერატორები ორგანიზაციის მიხედვით
პოსტი	/api/ოპერატორი/სინქრონიზაცია	ახალი ოპერატორების დამატება
პოსტი	/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 OK - მოთხოვნა წარმატებით დასრულდა
• 400 ცუდი მოთხოვნა - არასწორი მოთხოვნის ფორმატი
• 401 არაავტორიზებული - ავტორიზაცია ვერ მოხერხდა
• 403 აკრძალულია - არასაკმარისი ნებართვები
• 404 ვერ მოიძებნა - რესურსი ვერ მოიძებნა
• 500 შიდა სერვერის შეცდომა - სერვერის შეცდომა

ტოკენის ვადა

ჟეტონებს აქვთ ვადის გასვლის დრო. როდესაც ჟეტონი იწურება:

1. API დააბრუნებს 401 არაავტორიზებული
2. მოითხოვეთ ახალი ჟეტონი ავტორიზაციის საბოლოო წერტილის გამოყენებით
3. განაახლეთ თქვენი აპლიკაცია ახალი ტოკენით

შემდეგი ნაბიჯები

• ავთენტიფიკაცია - ისწავლეთ ავტორიზაცია
• ორგანიზაციები - ორგანიზაციების მართვა
• ოპერატორები - ოპერატორებთან მუშაობა
• ვიჯეტის ინტეგრაცია - ჩატის ვიჯეტის ინტეგრირება