Webhook’lar ve REST API
Conviro, gerçek zamanlı olay bildirimleri için webhook’lar ve platformun tüm özelliklerine programatik erişim için bir REST API sunar.
Webhook’lar
Webhook Nedir?
Webhook’lar, Conviro’da belirli bir olay gerçekleştiğinde sunucunuza bir HTTP POST isteği gönderir. Böylece sürekli sorgulama (polling) yapmadan gerçek zamanlı tepki verebilirsiniz.
Kullanılabilir Olaylar
| Olay | Ne Zaman Tetiklenir |
|---|---|
message.new | Yeni bir mesaj gönderildiğinde (ziyaretçi veya bot tarafından) |
session.started | Yeni bir görüşme oturumu başladığında |
session.closed | Bir görüşme kapatıldığında |
session.handoff | Bir görüşme canlı temsilciye aktarıldığında |
lead.captured | Yeni bir potansiyel müşteri kaydedildiğinde |
contact.created | Yeni bir kişi oluşturulduğunda |
ticket.created | Bir destek talebi açıldığında |
csat.submitted | Bir CSAT puanı gönderildiğinde |
Kurulum
- Dashboard -> Settings -> Webhooks yolunu açın.
- Add Webhook’a tıklayın.
- Uç nokta URL’nizi girin (HTTPS olmalıdır).
- Almak istediğiniz olayları seçin.
- Save’e tıklayın.
Güvenlik: HMAC-SHA256 İmzalama
Her webhook yükü, webhook secret’ınız kullanılarak HMAC-SHA256 ile imzalanır. Gerçekliğinden emin olmak için imzayı kendi sunucunuzda doğrulayın:
X-Conviro-Signature: sha256=<hex_digest>
Bu başlığı, webhook secret’ınızla hesapladığınız ham istek gövdesinin HMAC-SHA256 özetiyle karşılaştırın.
Yeniden Deneme Politikası
Uç noktanız 2xx dışında bir durum kodu döndürürse Conviro, üstel geri çekilmeyle (1 dk, 5 dk, 30 dk) en fazla 3 kez yeniden dener.
REST API
Kimlik Doğrulama
- Dashboard -> Settings -> API Keys -> Create Key üzerinden bir API anahtarı oluşturun.
- Anahtarı
Authorizationbaşlığına ekleyin:
Authorization: Bearer sk_your_api_key_here
Başlıca Uç Noktalar
| Metot | Uç Nokta | Açıklama |
|---|---|---|
| GET | /api/chatbots | Tüm chatbot’ları listeler |
| GET | /api/chatbots/:id | Chatbot ayrıntılarını getirir |
| GET | /api/sessions | Oturumları listeler (filtrelerle) |
| GET | /api/sessions/:id/messages | Bir oturumun mesajlarını getirir |
| POST | /api/sessions/:id/messages | Bir oturuma mesaj gönderir |
| GET | /api/contacts | Kişileri listeler |
| POST | /api/contacts | Kişi oluşturur |
| GET | /api/leads | Potansiyel müşterileri listeler |
| POST | /api/leads | Potansiyel müşteri oluşturur |
| GET | /api/analytics/overview | Analiz özetini getirir |
İstek Limitleri
- Free planı: dakikada 60 istek
- Starter: dakikada 120 istek
- Pro: dakikada 300 istek
- Growth+: dakikada 600 istek
İstek limiti başlıkları her yanıta eklenir:
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1672531200
Tam Dokümantasyon
İstek/yanıt örnekleriyle birlikte eksiksiz API referansı için /developers adresini ziyaret edin.