အကြောင်းအရာသို့ ကရန်

SMSBAT ChatHub API

ChatHub REST API သည် Viber လုပ်ငန်းချတ်များ၊ ကလိုင်းယင့်စကားဝိုင်းများနှင့် ဖောက်သည်ပံ့ပိုးမှုဆိုင်ရာ အလိုအလျောက်လုပ်ဆောင်မှုလုပ်ငန်းစဉ်များကို စီမံခန့်ခွဲသည်။

အခြေခံ URL

https://chatapi.smsbat.com

Swagger Documentation

Interactive API စာရွက်စာတမ်းကို အောက်ပါလင့်တွင် ရနိုင်ပါသည်

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

စစ်မှန်ကြောင်းအထောက်အထားပြခြင်း။

ChatHub သည် JWT တိုကင်များဖြင့် Bearer တိုကင်-အခြေခံ စစ်မှန်ကြောင်းအထောက်အထားပြစနစ်ကို အသုံးပြုသည်။ တိုကင်များကို နည်းလမ်းနှစ်မျိုးဖြင့် ပေးပို့နိုင်ပါသည်။

နည်းလမ်း 1- ခွင့်ပြုချက် ခေါင်းစီး

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

နည်းလမ်း 2- X-Authorization-Key ခေါင်းစီး

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

Authentication Flow

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]

ပင်မအဆုံးမှတ်များ

နည်းလမ်း အဆုံးမှတ် ဖော်ပြချက်
POST /api/company/get-token ကုမ္ပဏီခွင့်ပြုချက်တိုကင်ရယူရန်
GET /api/company/organization အဖွဲ့အစည်းစာရင်း
GET /api/operator အဖွဲ့အစည်းအလိုက် အော်ပရေတာများစာရင်း
POST /api/operator/synchronize အော်ပရေတာများ
POST /api/operator/status အော်ပရေတာ အခြေအနေ
POST /api/operator/get-token အော်ပရေတာတိုကင်များထုတ်ပေးပါ (အမြင့်ဆုံး 24 နာရီ သက်တမ်းကုန်ဆုံးသည်)
POST /api/operator/validate-token တိုကင်၏တရားဝင်မှုကို အတည်ပြုပါ

အဓိကအင်္ဂါရပ်များ

ကုမ္ပဏီတိုကင်စီမံခန့်ခွဲမှု

API အသုံးပြုခွင့်အတွက် အဖွဲ့အစည်းအဆင့် တိုကင်များကို ရယူပြီး စီမံခန့်ခွဲပါ။

အဖွဲ့အစည်းစီမံခန့်ခွဲမှု

  • အဖွဲ့အစည်းအားလုံးကိုစာရင်းပြုစုပါ။
  • အဖွဲ့အစည်းအသေးစိတ်အချက်အလက်များကိုရယူပါ။
  • အဖွဲ့အစည်းဆက်တင်များကိုစီမံပါ။

အော်ပရေတာစီမံခန့်ခွဲမှု

  • အဖွဲ့အစည်းအလိုက် အော်ပရေတာများကို စာရင်းပြုစုပါ။
  • အော်ပရေတာအသစ်များထည့်ပါ။
  • အော်ပရေတာအခြေအနေ (Active/Inactive/Deleted)
  • အော်ပရေတာ-သီးသန့် တိုကင်များကို ထုတ်လုပ်ပါ (အမြင့်ဆုံး 24 နာရီ)
  • အော်ပရေတာတိုကင်များကိုအတည်ပြုပါ။

Widget ပေါင်းစည်းခြင်း။

အချိန်နှင့်တစ်ပြေးညီ သုံးစွဲသူပံ့ပိုးမှုအတွက် ChatHub ဝစ်ဂျက်ကို ဝဘ်အပလီကေးရှင်းများတွင် ပေါင်းစည်းပါ။

အမြန်စတင်ပါ။

  1. Authentication - သင့်ကုမ္ပဏီနှင့် အော်ပရေတာတိုကင်များကို ရယူပါ
  2. Organizations - အဖွဲ့အစည်းများကို စီမံခန့်ခွဲပါ။
  3. အော်ပရေတာ - အော်ပရေတာများကို ပေါင်းထည့်၍ စီမံပါ။
  4. Widget ပေါင်းစည်းခြင်း - ချတ်ဝစ်ဂျက်ကို ပေါင်းစပ်ပါ

တောင်းဆိုမှုပုံစံ

တောင်းဆိုချက်အားလုံး JSON ဖော်မတ်ကို အသုံးပြုသည်-

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

တုံ့ပြန်မှုပုံစံ

အောင်မြင်သော တုံ့ပြန်မှုများ ပြန်လာသည်-

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

ကိုင်တွယ်မှုအမှား

HTTP အခြေအနေကုဒ်များ

  • 200 OK - တောင်းဆိုမှု အောင်မြင်ပါပြီ။
  • 400 Bad Request - မမှန်ကန်သော တောင်းဆိုချက်ဖော်မတ်
  • 401 ခွင့်ပြုချက်မရှိဘဲ - အထောက်အထားစိစစ်ခြင်း မအောင်မြင်ပါ။
  • 403 Forbidden - ခွင့်ပြုချက် မလုံလောက်ပါ။
  • 404 Not Found - အရင်းအမြစ် ရှာမတွေ့ပါ။
  • 500 အတွင်း ဆာဗာ အမှား - ဆာဗာ အမှား

တိုကင်သက်တမ်းကုန်ဆုံးခြင်း။

တိုကင်များတွင် သက်တမ်းကုန်ဆုံးချိန်ရှိသည်။ တိုကင်တစ်ခု သက်တမ်းကုန်သောအခါ-

  1. API သည် 401 Unauthorized ကို ပြန်ပေးပါမည်။
  2. အထောက်အထားစိစစ်ခြင်း အဆုံးမှတ်ကို အသုံးပြု၍ တိုကင်အသစ်တစ်ခု တောင်းဆိုပါ။
  3. သင့်လျှောက်လွှာကို တိုကင်အသစ်ဖြင့် အပ်ဒိတ်လုပ်ပါ။

နောက်အဆင့်များ