Help Center Index

Index

#API ChatHub SMSBAT

L’API REST ChatHub gère les discussions professionnelles Viber, les conversations clients et les flux de travail d’automatisation du support client.

URL de base

https://chatapi.smsbat.com

Documentation Swagger

La documentation interactive de l’API est disponible à l’adresse :

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

Authentification

ChatHub utilise un système d’authentification basé sur des jetons Bearer avec des jetons JWT. Les jetons peuvent être transmis de deux manières :

Méthode 1 : en-tête d’autorisation

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

Méthode 2 : en-tête X-Authorization-Key

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

Flux d’authentification

ChatHub utilise un système de jetons à deux niveaux :

  1. Jeton d’entreprise – Jeton d’accès au niveau de l’organisation
  2. Jeton d’opérateur - Jeton d’accès d’opérateur individuel

Flux de travail

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

Principaux paramètres

MéthodePoint de terminaisonDescriptif
POSTER/api/company/get-tokenObtenir le jeton d’autorisation de l’entreprise
OBTENIR/api/entreprise/organisationRécupérer la liste des organisations
OBTENIR/api/opérateurListe des opérateurs par organisation
POSTER/api/operator/synchronizeAjouter de nouveaux opérateurs
POSTER/api/opérateur/statutChanger le statut d’opérateur
POSTER/api/operator/get-tokenGénérer des jetons d’opérateur (expiration max 24h)
POSTER/api/operator/validate-tokenVérifier la validité du jeton

Principales fonctionnalités

Gestion des jetons d’entreprise

Obtenez et gérez des jetons au niveau de l’organisation pour l’accès aux API.

Gestion de l’organisation

  • Répertorier toutes les organisations
  • Récupérer les détails de l’organisation
  • Gérer les paramètres de l’organisation

Gestion des opérateurs

  • Liste des opérateurs par organisation
  • Ajouter de nouveaux opérateurs
  • Changer le statut de l’opérateur (Actif/Inactif/Supprimé)
  • Générer des jetons spécifiques à l’opérateur (max 24 heures)
  • Valider les jetons de l’opérateur

Intégration de widgets

Intégrez le widget ChatHub dans les applications Web pour un support client en temps réel.

Démarrage rapide

  1. Authentification - Obtenez les jetons de votre entreprise et de votre opérateur
  2. Organisations – Gérer les organisations
  3. Opérateurs - Ajouter et gérer des opérateurs
  4. Intégration du widget - Intégrer le widget de chat

Format de la demande

Toutes les requêtes utilisent le format JSON :

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

Format de réponse

Les réponses positives reviennent :

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

Gestion des erreurs

Codes d’état HTTP :

  • 200 OK - Demande réussie
  • 400 Bad Request - Format de requête invalide
  • 401 Non autorisé - Échec de l’authentification
  • 403 Forbidden - Autorisations insuffisantes
  • 404 Not Found - Ressource introuvable
  • 500 Erreur de serveur interne - Erreur de serveur

Expiration du jeton

Les jetons ont un délai d’expiration. Lorsqu’un jeton expire :

  1. L’API renverra « 401 non autorisé »
  2. Demandez un nouveau jeton à l’aide du point de terminaison d’authentification
  3. Mettez à jour votre application avec le nouveau token

Prochaines étapes