API referansı

WiChat, kendi sisteminizden erişebileceğiniz bir HTTP API sunar. Bu sayfa temelleri anlatır: kimlik doğrulama, yanıt biçimi ve uç nokta grupları.

Temel bilgiler

Konu	Değer
Temel adres	`https://chat.wi.tr/chat-gateway`
Biçim	JSON
Karakter kodlaması	UTF-8
Yöntem	Çoğunlukla `GET` ve `POST`

Kimlik doğrulama

Ne yapmak istediğinize göre farklı doğrulama yöntemleri kullanılır:

Yöntem	Başlık	Kimin için
Servis anahtarı	`X-Service-Key`	Kendi sunucunuzdan yapılan çağrılar — rehber
Oturum jetonu	`Authorization: Bearer …`	Panele giriş yapmış operatörler
Widget jetonu	`X-Widget-Token`	Web sitesindeki sohbet balonu

Hangisini kullanmalıyım?Kendi yazılımınızdan entegrasyon yapıyorsanız servis anahtarı doğru yöntemdir. Diğer ikisi panelin ve widget’ın kendi iç kullanımı içindir.

Yanıt biçimi

Tüm yanıtlar aynı yapıyı izler:

başarılı yanıt

{
  "status": "success",
  "data": { }
}

hatalı yanıt

{
  "status": "danger",
  "data": "Hata açıklaması"
}

status alanı üç değer alabilir: success (başarılı), warning (uyarı) ve danger (hata). İşleminizin sonucunu HTTP durum koduna ek olarak bu alandan da kontrol edin.

Uç nokta grupları

API, işlevlerine göre gruplanmıştır:

Grup	Ne yapar
Sohbet	Sohbet listeleme, detay, kapatma, atama
Mesaj	Mesaj gönderme ve listeleme
Rehber	Kişi kayıtları
Şablon	Hazır mesaj şablonları
Kanal	Kanal yapılandırması
Operatör	Operatör durumu ve yönetimi
İstatistik	Raporlama verileri
Dosya	Dosya yükleme ve indirme
Widget	WebChat widget yapılandırması
Chatbot	Akış yönetimi

Yönetim uçları iç ağa kapalıdırYönetim (/admin/ ile başlayan) uçları dış dünyaya kapalıdır ve yalnızca izinli ağlardan erişilebilir. Servis anahtarınızın hangi uçlara erişebileceği anahtar tanımında belirlenir.

Örnek çağrı

örnek istek

curl -X GET "https://chat.wi.tr/chat-gateway/ORNEK-UC" \
  -H "X-Service-Key: svc_••••••••" \
  -H "Content-Type: application/json"

Hata yönetimi

Entegrasyonunuzu yazarken şunları hesaba katın:

Durum	Ne yapmalı
Erişim reddedildi	Anahtarın IP ve uç nokta izinlerini kontrol edin
Geçersiz istek	Gönderdiğiniz alanları ve biçimlerini doğrulayın
Bulunamadı	Çağırdığınız kaydın var olduğundan emin olun
Geçici hata	Bir süre bekleyip tekrar deneyin; sonsuz döngüye girmeyin
Zaman aşımı	İsteği tekrarlamadan önce işlemin gerçekleşip gerçekleşmediğini kontrol edin

Ayrıntılı uç listesiKullanacağınız uçların tam listesi, parametreleri ve örnek yanıtları için ekibimizle iletişime geçin — iletişim sayfası. Entegrasyonunuza uygun uç listesini ve erişim yetkilerini birlikte belirleriz.