Simpliers CHAT API
Otomasyonlarınızı listeleyin, yayınlayın ve yayından kaldırın.
Son güncelleme: 10 Eylül 2026
Kapsam
Bu API panelde kurulmuş otomasyonların durumunu okur ve değiştirir. Otomasyon kurmak, düzenlemek, silmek ya da mesaj göndermek için endpoint'ler mevcut değildir.
- Kimlik doğrulama, Authorization header'ındaki Bearer key ile yapılır. Key panelde oluşturulur ve tam hâli yalnız oluşturulduğu anda görünür.
- Key'in erişim düzeyi oluşturulurken belirlenir ve sonradan değişmez: ya yalnız görüntüleme, ya da görüntüleme ile yayınlama ve yayından kaldırma seçmelisiniz.
- Request'ler yalnız sunucudan gönderilir. Origin header'ı taşıyan request'ler 403 döner, yani tarayıcı ya da mobil uygulama bu API'yi kullanamaz.
- Rate limit key başına dakikada 120, IP başına 300 request'tir. Limiti aşan request 429 döner.
Kimlik doğrulama
Her request tek bir key taşır. Request'te hesap id'si gönderilmez. Key panelde hesap ayarlarındaki Entegrasyonlar sekmesinin API key'leri bölümünde oluşturulur.
- Panelde hesap ayarlarını aç, Entegrasyonlar sekmesindeki API key'leri bölümüne geç.
- Yeni key oluştur ve erişim düzeyini seç.
- Key'i sunucunun ortam değişkenlerine kaydet.
Key her request'te Authorization header'ıyla gönderilir:
Authorization: Bearer smpl_... Key tarayıcıya ya da mobil uygulamaya gömülemez. Origin header'ı taşıyan request 403 browser_origin_not_allowed döner, çünkü tarayıcı bu header'ı her request'e ekler.
Erişim düzeyleri
Erişim düzeyi key oluşturulurken seçilir ve key'in ömrü boyunca değişemez.
Yalnız Görüntüleme
Otomasyon listesini okur. Durum değiştiren request'lerde 403 missing_scope döner.
Görüntüleme ve Yönetme
Otomasyon listesini okur; bir otomasyonu yayınlar ya da yayından kaldırır.
Endpoint'ler
Tüm endpoint'ler https://api.simpliers.com altındadır.
Komutlar terminalde çalışır. {flowId} yerine otomasyonun id'si, "smpl_..." yerine kendi key'in yazılır. Yayınlama ve yayından kaldırma request'lerinde body gönderilmez.
Otomasyonları listele
GET /api/v1/chat/flows?status=published
Parametreler virgül ile ayrılır. status=published parametresi yalnız yayında olan otomasyonları, status=unpublished parametresi yalnız yayından kaldırılmış otomasyonları döner. Parametre verilmezse hesabın tüm otomasyonları listelenir. "limit" ile sayfa boyutu belirlenir. Sayfa boyutu varsayılan 25, en fazla 100. flowId de bu response'tan alınır.
curl -H "Authorization: Bearer smpl_..." \ "https://api.simpliers.com/api/v1/chat/flows?status=published"
Bir otomasyonu yayınla
POST /api/v1/chat/flows/{flowId}/publish
curl -X POST -H "Authorization: Bearer smpl_..." \ "https://api.simpliers.com/api/v1/chat/flows/{flowId}/publish"
Bir otomasyonu yayından kaldır
POST /api/v1/chat/flows/{flowId}/unpublish
Yayından kaldırılan otomasyon yeniden yayınlanana kadar çalışmaz, kurulumu silinmez.
curl -X POST -H "Authorization: Bearer smpl_..." \ "https://api.simpliers.com/api/v1/chat/flows/{flowId}/unpublish"
Response kodları
Hatalar için response'ta error objesinde code ve message alanı bulunur. code sabittir, message metni değişebilir.
{ "error": { "code": "missing_scope", "message": "..." }}
- 403 browser_origin_not_allowedRequest'te Origin header'ı varsa, yani request tarayıcıdan geldiyse hata döner. Key yalnız sunucudan kullanılır.
- 403 missing_scopeKey bu endpoint için gereken erişim düzeyinde değil. Yalnız görüntüleme düzeyindeki key durum değiştiremez.
- 404 flow_not_foundOtomasyon bulunamadı. Başka bir hesaba ait otomasyon da bu kodu döner.
- 429 rate_limit_exceededRequest limiti aşıldı. Aynı request bir dakika sonra tekrarlanabilir.
Kurallar ve limitler
Key için kurallar:
- Request limitiKey başına dakikada 120, IP başına 300 request. Limiti aşan request 429 rate_limit_exceeded döner.
- Hesap kapsamıRequest'te hesap id'si gönderilmez, bir key yalnız kendi hesabının otomasyonlarını görür.
- Bloke hesapResponse'taki account.effective alanı blocked ise otomasyon yayında görünse bile çalışmaz. Request başarılı döner, otomasyon tetiklenmez.
- Key değişimiKey'in adı ve erişim düzeyi sonradan düzenlenmez. Yeni key oluşturup sunucudaki değeri değiştirebilirsiniz.