Kihagyás

SMSBAT ChatHub API

A ChatHub REST API kezeli a Viber üzleti csevegéseket, az ügyfélbeszélgetéseket és az ügyfélszolgálat automatizálási munkafolyamatait.

Alap URL

https://chatapi.smsbat.com

Swagger dokumentáció

Az interaktív API dokumentáció a következő címen érhető el:

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

Hitelesítés

A ChatHub egy Bearer token alapú hitelesítési rendszert használ JWT tokenekkel. A tokeneket kétféleképpen lehet átadni:

1. módszer: Engedélyezési fejléc

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

2. módszer: X-Authorization-Key fejléc

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

Hitelesítési folyamat

A ChatHub kétszintű tokenrendszert használ:

  1. Vállalati token – Szervezeti szintű hozzáférési token
  2. Operator Token – Egyéni kezelői hozzáférési token

Munkafolyamat

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

Fő végpontok

Módszer Végpont Leírás
POST "/api/vállalat/get-token" Vállalati jogosultsági token beszerzése
GET "/api/vállalat/szervezet" Szervezeti lista lekérése
GET "/api/operátor" Operátorok listázása szervezetenként
POST "/api/operator/synchronize" Új operátorok hozzáadása
POST "/api/operátor/állapot" Kezelői állapot módosítása
POST "/api/operator/get-token" Operátori tokenek generálása (max. 24 órás lejárat)
POST "/api/operator/validate-token" A token érvényességének ellenőrzése

Főbb jellemzők

Vállalati tokenkezelés

Szerezzen be és kezeljen szervezeti szintű tokeneket az API-hozzáféréshez.

Szervezetkezelés

  • Sorolja fel az összes szervezetet
  • Szervezeti adatok lekérése
  • Szervezeti beállítások kezelése

Operátorkezelés

  • Szervezetenként sorolja fel az operátorokat
  • Új operátorok hozzáadása
  • Kezelői állapot módosítása (aktív/inaktív/törölt)
  • Operátorspecifikus tokeneket generál (max. 24 óra)
  • Az operátori tokenek érvényesítése

Widget integráció

Integrálja a ChatHub widgetet webes alkalmazásokba a valós idejű ügyfélszolgálat érdekében.

Gyorsindítás

  1. Hitelesítés – Szerezze be a vállalati és üzemeltetői tokeneket
  2. Szervezetek - Szervezetek kezelése
  3. Operátorok - Operátorok hozzáadása és kezelése
  4. Widget integráció – Csevegőmodul integrálása

Formátum kérése

Minden kérelem JSON formátumot használ:

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

Válaszformátum

A sikeres válaszok visszaküldése:

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

Hibakezelés

HTTP állapotkódok:

  • "200 OK" - A kérés sikeres
  • 400 hibás kérés - Érvénytelen kérésformátum
  • 401 Jogosulatlan - A hitelesítés nem sikerült
  • 403 Tiltott - Nincs elegendő engedély
  • 404 Nem található - Az erőforrás nem található
  • "500 Belső szerverhiba" - Szerverhiba

Token lejárata

A tokeneknek lejárati ideje van. Amikor egy token lejár:

  1. Az API a "401 Unauthorized" értéket adja vissza
  2. Kérjen új tokent a hitelesítési végpont használatával
  3. Frissítse az alkalmazást az új tokennel

Következő lépések