Անցնել պարունակությանը

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. Operator Token - Անհատական օպերատորի մուտքի նշան

Աշխատանքային ընթացք

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/ընկերություն/կազմակերպություն» Առբերեք կազմակերպությունների ցուցակը
ՍՏԱՆԱԼ /api/operator Թվարկել օպերատորներին ըստ կազմակերպության
ՓՈՍՏ «/api/operator/sychronize» Ավելացնել նոր օպերատորներ
ՓՈՍՏ «/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 Not Found» - Ռեսուրսը չի գտնվել
  • 500 ներքին սերվերի սխալ - Սերվերի սխալ

Նշանի ժամկետի ավարտը

Նշաններն ունեն պիտանելիության ժամկետ: Երբ նշանն ավարտվում է.

  1. API-ն կվերադարձնի «401 Չլիազորված»:
  2. Պահանջեք նոր նշան՝ օգտագործելով վավերացման վերջնակետը
  3. Թարմացրեք ձեր դիմումը նոր նշանով

Հաջորդ քայլերը