Vai al contenuto

API SMSBAT ChatHub

L'API REST di ChatHub gestisce le chat aziendali, le conversazioni con i clienti e i flussi di lavoro di automazione dell'assistenza clienti di Viber.

URL di base

https://chatapi.smsbat.com

Documentazione spavalda

La documentazione API interattiva è disponibile all'indirizzo:

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

Autenticazione

ChatHub utilizza un sistema di autenticazione basato su token Bearer con token JWT. I token possono essere passati in due modi:

Metodo 1: intestazione dell'autorizzazione

CODICE_BLOCCO_2

Metodo 2: intestazione chiave di autorizzazione X

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

Flusso di autenticazione

ChatHub utilizza un sistema di token a due livelli:

  1. Token aziendale: token di accesso a livello di organizzazione
  2. Token operatore: token di accesso operatore individuale

Flusso di lavoro

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

Endpoint principali

Metodo Punto finale Descrizione
POST /api/azienda/get-token Ottieni il token di autorizzazione dell'azienda
OTTIENI /api/azienda/organizzazione Recupera l'elenco delle organizzazioni
OTTIENI /api/operatore Elenco operatori per organizzazione
POST /api/operatore/sincronizza Aggiungi nuovi operatori
POST /api/operatore/status Modifica stato operatore
POST /api/operator/get-token Genera token operatore (scadenza max 24 ore)
POST /api/operator/validate-token Verificare la validità del token

Caratteristiche principali

Gestione dei token aziendali

Ottieni e gestisci token a livello di organizzazione per l'accesso API.

Gestione dell'organizzazione

  • Elenca tutte le organizzazioni
  • Recuperare i dettagli dell'organizzazione
  • Gestire le impostazioni dell'organizzazione

Gestione degli operatori

  • Elenco operatori per organizzazione
  • Aggiungere nuovi operatori
  • Modifica stato operatore (Attivo/Inattivo/Eliminato)
  • Genera token specifici dell'operatore (max 24 ore)
  • Convalidare i token dell'operatore

Integrazione dei widget

Integra il widget ChatHub nelle applicazioni web per l'assistenza clienti in tempo reale.

Avvio rapido

  1. Autenticazione - Ottieni i token della tua azienda e del tuo operatore
  2. Organizzazioni - Gestisci le organizzazioni
  3. Operatori - Aggiungi e gestisci gli operatori
  4. Integrazione widget - Integra il widget chat

Richiedi formato

Tutte le richieste utilizzano il formato JSON:

CODICE_BLOCCO_5

Formato della risposta

Le risposte riuscite restituiscono:

CODICE_BLOCCO_6

Gestione degli errori

Codici di stato HTTP:

  • "200 OK" - Richiesta riuscita
  • "400 Bad Request" - Formato di richiesta non valido
  • "401 Non autorizzato" - Autenticazione fallita
  • "403 Forbidden" - Autorizzazioni insufficienti
  • "404 Non trovato" - Risorsa non trovata
  • "500 Errore interno del server" - Errore del server

Scadenza del token

I token hanno una scadenza. Quando un token scade:

  1. L'API restituirà "401 Non autorizzato".
  2. Richiedi un nuovo token utilizzando l'endpoint di autenticazione
  3. Aggiorna la tua applicazione con il nuovo token

Passaggi successivi