Skip to content

SMSBAT ChatHub API

ChatHub REST API jimmaniġġja ċ-chats tan-negozju ta’ Viber, il-konversazzjonijiet mal-klijenti, u l-flussi tax-xogħol tal-awtomazzjoni tal-appoġġ tal-klijenti.

URL tal-bażi

https://chatapi.smsbat.com

Swagger Dokumentazzjoni

Dokumentazzjoni interattiva tal-API hija disponibbli fuq:

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

Awtentikazzjoni

ChatHub juża sistema ta 'awtentikazzjoni bbażata fuq tokens Bearer b'tokens JWT. It-tokens jistgħu jgħaddu b'żewġ modi:

Metodu 1: Awtorizzazzjoni Header

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

Metodu 2: X-Authorization-Key Header

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

Fluss ta' Awtentikazzjoni

ChatHub juża sistema ta' tokens fuq żewġ livelli:

  1. Company Token - Token ta' aċċess fil-livell ta' organizzazzjoni
  2. Token tal-Operatur - Token tal-aċċess tal-operatur individwali

Fluss tax-xogħol

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

Endpoints Prinċipali

Metodu Endpoint Deskrizzjoni
POST /api/company/get-token Ikseb token ta' awtorizzazzjoni tal-kumpanija
IKOLLOK "/api/kumpanija/organizzazzjoni" Irkupra l-lista tal-organizzazzjoni
IKOLLOK /api/operator Elenka l-operaturi skond l-organizzazzjoni
POST /api/operator/synchronize Żid operaturi ġodda
POST /api/operator/status Ibdel l-istatus ta' l-operatur
POST /api/operator/get-token Iġġenera tokens tal-operatur (massimu ta' skadenza ta' 24 siegħa)
POST /api/operator/validate-token Ivverifika l-validità tat-token

Karatteristiċi Ewlenin

Ġestjoni tat-Token tal-Kumpanija

Ikseb u mmaniġġja tokens fil-livell tal-organizzazzjoni għall-aċċess tal-API.

Ġestjoni tal-Organizzazzjoni

  • Elenka l-organizzazzjonijiet kollha
  • Irkupra d-dettalji tal-organizzazzjoni
  • Immaniġġja s-settings tal-organizzazzjoni

Ġestjoni tal-Operatur

  • Elenka l-operaturi skont l-organizzazzjoni
  • Żid operaturi ġodda
  • Ibdel l-istatus tal-operatur (Attiv/Inattiv/Imħassar)
  • Iġġenera tokens speċifiċi għall-operatur (massimu 24 siegħa)
  • Ivvalida t-tokens tal-operatur

Integrazzjoni tal-Widget

Integra l-widget ChatHub f'applikazzjonijiet tal-web għal appoġġ għall-klijenti f'ħin reali.

Quick Start

  1. Awtentikazzjoni - Ikseb it-tokens tal-kumpanija u tal-operatur tiegħek
  2. Organizzazzjonijiet - Immaniġġja organizzazzjonijiet
  3. Operaturi - Żid u mmaniġġja l-operaturi
  4. Integrazzjoni tal-Widget - Integra l-widget taċ-chat

Format tat-Talba

It-talbiet kollha jużaw il-format JSON:

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

Format ta’ Rispons

Risposti b'suċċess jerġgħu lura:

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

Immaniġġjar ta' Żbalji

Kodiċi tal-istatus HTTP:

  • "200 OK" - Talba b'suċċess
  • 400 Talba Ħażina - Format ta' talba mhux validu
  • `401 Mhux awtorizzat' - Awtentikazzjoni falliet
  • "403 Ipprojbit" - Permessi insuffiċjenti
  • `404 Not Found' - Riżorsa ma nstabx
  • "500 Żball Intern tas-Server" - Żball tas-server

Skadenza tat-Token

It-tokens għandhom żmien ta' skadenza. Meta token jiskadi:

  1. L-API se jirritorna "401 Mhux Awtorizzat".
  2. Itlob token ġdid billi tuża l-endpoint tal-awtentikazzjoni
  3. Aġġorna l-applikazzjoni tiegħek bit-token il-ġdid

Il-passi li jmiss