Ana içeriğe geç

SMSBAT ChatHub API'si

ChatHub REST API, Viber iş sohbetlerini, müşteri görüşmelerini ve müşteri desteği otomasyon iş akışlarını yönetir.

Temel URL

https://chatapi.smsbat.com

Swagger Belgeleri

Etkileşimli API belgelerine şu adresten ulaşılabilir:

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

Kimlik Doğrulama

ChatHub, JWT belirteçleriyle Taşıyıcı belirteci tabanlı bir kimlik doğrulama sistemi kullanır. Jetonlar iki şekilde aktarılabilir:

Yöntem 1: Yetkilendirme Başlığı

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

Yöntem 2: X-Yetkilendirme-Anahtar Başlığı

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

Kimlik Doğrulama Akışı

ChatHub iki seviyeli bir jeton sistemi kullanır:

  1. Şirket Jetonu - Kuruluş düzeyinde erişim jetonu
  2. Operatör Jetonu - Bireysel operatör erişim jetonu

İş Akışı

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

Ana Uç Noktalar

Yöntem Uç nokta Açıklama
YAYIN /api/şirket/get-token Şirket yetkilendirme jetonunu edinin
AL /api/şirket/organizasyon Organizasyon listesini al
AL /api/operatör Operatörleri kuruluşa göre listeleyin
YAYIN /api/operatör/synchronize Yeni operatörler ekle
YAYIN /api/operatör/durum Operatör durumunu değiştir
YAYIN /api/operatör/get-token Operatör belirteçleri oluşturun (en fazla 24 saatlik süre sonu)
YAYIN /api/operatör/validate-token Belirtecin geçerliliğini doğrulayın

Temel Özellikler

Şirket Token Yönetimi

API erişimi için kuruluş düzeyinde belirteçler edinin ve yönetin.

Organizasyon Yönetimi

  • Tüm kuruluşları listeleyin
  • Organizasyon ayrıntılarını alın
  • Organizasyon ayarlarını yönetin

Operatör Yönetimi

  • Operatörleri kuruluşa göre listeleyin
  • Yeni operatörler ekleyin
  • Operatör durumunu değiştirin (Aktif/Aktif Değil/Silinmiş)
  • Operatöre özel jetonlar oluşturun (maks. 24 saat)
  • Operatör belirteçlerini doğrulayın

Widget Entegrasyonu

Gerçek zamanlı müşteri desteği için ChatHub widget'ını web uygulamalarına entegre edin.

Hızlı Başlangıç

  1. Kimlik Doğrulama - Şirketinizin ve operatör jetonlarınızın alınması
  2. Kuruluşlar - Kuruluşları yönetin
  3. Operatörler - Operatörleri ekleyin ve yönetin
  4. Widget Entegrasyonu - Sohbet widget'ını entegre edin

Talep Formatı

Tüm istekler JSON biçimini kullanır:

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

Yanıt Formatı

Başarılı yanıtlar geri döner:

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

Hata İşleme

HTTP durum kodları:

  • 200 OK - İstek başarılı
  • 400 Hatalı İstek - Geçersiz istek biçimi
  • 401 Yetkisiz - Kimlik doğrulama başarısız oldu
  • 403 Yasak - Yetersiz izinler
  • 404 Bulunamadı - Kaynak bulunamadı
  • 500 Dahili Sunucu Hatası - Sunucu hatası

Tokenın Sona Ermesi

Jetonların bir son kullanma süresi vardır. Bir jetonun süresi dolduğunda:

  1. API '401 Yetkisiz' sonucunu döndürecektir
  2. Kimlik doğrulama uç noktasını kullanarak yeni bir belirteç isteyin
  3. Başvurunuzu yeni jetonla güncelleyin

Sonraki Adımlar