Hyppää sisältöön

SMSBAT ChatHub API

ChatHub REST API hallitsee Viber-yrityskeskusteluja, asiakaskeskusteluja ja asiakastuen automatisoinnin työnkulkuja.

Perus-URL-osoite

https://chatapi.smsbat.com

Swaggerin dokumentaatio

Interaktiivinen API-dokumentaatio on saatavilla osoitteessa:

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

Todennus

ChatHub käyttää Bearer-tunnuspohjaista todennusjärjestelmää JWT-tunnisteilla. Tokenit voidaan välittää kahdella tavalla:

Tapa 1: Valtuutusotsikko

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

Tapa 2: X-Authorization-Key Header

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

Todennuskulku

ChatHub käyttää kaksitasoista merkkijärjestelmää:

  1. Yritystunnus – Organisaatiotason käyttöoikeustunnus
  2. Operator Token - Yksittäinen operaattorin käyttöoikeustunnus

Työnkulku

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

Pääpäätepisteet

Menetelmä Päätepiste Kuvaus
POST "/api/yritys/get-token" Hanki yrityksen valtuutustunnus
HANKI "/api/yritys/organisaatio" Hae organisaatioluettelo
HANKI "/api/operaattori" Luettelo operaattorit organisaatioittain
POST "/api/operator/synchronize" Lisää uusia operaattoreita
POST "/api/operaattori/tila" Muuta käyttäjän tilaa
POST "/api/operator/get-token" Luo operaattoritunnukset (enintään 24 tunnin voimassaoloaika)
POST "/api/operator/validate-token" Tarkista tunnuksen kelpoisuus

Tärkeimmät ominaisuudet

Yrityksen Token Management

Hanki ja hallitse organisaatiotason tunnuksia API-käyttöä varten.

Organisaation hallinta

  • Listaa kaikki organisaatiot
  • Hae organisaation tiedot
  • Hallitse organisaation asetuksia

Operaattorin hallinta

  • Listaa operaattorit organisaatioittain
  • Lisää uusia operaattoreita
  • Muuta operaattorin tilaa (aktiivinen/ei-aktiivinen/poistettu)
  • Luo operaattorikohtaisia tunnuksia (enintään 24 tuntia)
  • Vahvista operaattoritunnukset

Widget-integrointi

Integroi ChatHub-widget verkkosovelluksiin reaaliaikaista asiakastukea varten.

Pika-aloitus

  1. Todennus – Hanki yrityksesi ja operaattorisi tunnukset
  2. Organisaatiot - Hallinnoi organisaatioita
  3. Operaattorit - Lisää ja hallitse operaattoreita
  4. Widgetin integrointi - Integroi chat-widget

Pyydä muotoa

Kaikki pyynnöt käyttävät JSON-muotoa:

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

Vastausmuoto

Onnistuneet vastaukset palautuvat:

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

Virheiden käsittely

HTTP-tilakoodit:

  • "200 OK" - Pyyntö onnistui
  • "400 virheellinen pyyntö" - Virheellinen pyyntömuoto
  • 401 Luvaton - Todennus epäonnistui
  • "403 Kielletty" - Riittämättömät käyttöoikeudet
  • 404 Not Found - Resurssia ei löydy
  • "500 Sisäinen palvelinvirhe" - Palvelinvirhe

Tokenin vanheneminen

Tokeneilla on voimassaoloaika. Kun tunnus vanhenee:

  1. API palauttaa "401 Unauthorized".
  2. Pyydä uutta merkkiä todennuksen päätepisteen avulla
  3. Päivitä sovelluksesi uudella tunnuksella

Seuraavat vaiheet