POST isteği atabilen herhangi bir sistemden Flextell’e Lead aktarmanızı sağlar. Her bağlantının kendine ait bir adresi ve gizli anahtarı vardır. Bu adrese JSON ya da form verisi gönderirsiniz; Flextell kaydı sütun eşlemenize göre Lead’e çevirir.
Bu sayfa gönderen sistemin (entegratörün) bakış açısıyla yazılmıştır. Bağlantıyı panelden kurmak ve alan eşlemesini yapmak için Gelen lead webhook’u (panel) sayfasına bakın.
Nasıl çalışır
- Klinikte bir bağlantı oluşturursunuz. Bağlantı Taslak durumunda açılır ve adresi ile gizli anahtarı hazırdır.
- Dış sisteminiz kayıtları adrese gönderir. Flextell kaydı alır ve hemen
202ile yanıt verir. - Kayıt arka planda işlenir. İşleme yalnızca bağlantı Aktif ise yapılır.
- Sonuç, bağlantının Gelen Kayıtlar listesinde ve ilgili Lead’in kartında görünür.
Webhook adresi ve gizli anahtar
Her bağlantı için şu bilgiler panelde Bağlantı Bilgileri sekmesinde görünür. API’den de bağlantı nesnesinde gelir.- Gizli anahtarı yalnızca bağlantıyı düzenleme iznine (
Update:IntegrationConnection) sahip kullanıcılar görür. Diğer kullanıcılarda APIsecret: nulldöndürür. - Gizli anahtarı yenilemek için panelde Anahtarı Yenile’yi ya da
POST /api/v1/integration-connections/{id}/rotate-secretçağrısını kullanın. Eski anahtar hemen geçersiz olur. Gönderen sistemdeki başlık değerini güncellemezseniz401alırsınız. - Bağlantıyı silerseniz adres
404döndürür. Silmeden önce gelen kayıtlar ve oluşan Lead’ler korunur; ancak o sırada bekleyen kayıtlar hiçbir zaman işlenmez.
Bu adres kimlik doğrulaması gerektirmez:
Authorization başlığı ve X-Tenant göndermezsiniz. Klinik, adresteki uuid değerinden belirlenir. Gizli anahtarı yalnızca sunucu tarafında saklayın; tarayıcıdan çalışan koda gömmeyin.integrations:read ve integrations:write scope’larını ve X-Tenant başlığını ister.
İstek biçimi
- Sorgu dizesi (
?ad=...) okunmaz; veriyi gövdede gönderin. Content-TypeJSON değilse gövde form verisi olarak okunur.- Boş gövde,
{},[], sayı/metin listesi, liste içinde liste ya da boş bir öğe422ile reddedilir. - Bir istekte en fazla 500 kayıt gönderebilirsiniz. Daha fazlasında hiçbir kayıt saklanmaz (
413). - İç içe nesneler
contact.phonegibi nokta yollarıyla düzleştirilir. Eşlemede bu yolları kullanırsınız.
Lead alanları
Gelen kayıttaki sütunlar bir eşleme ile Lead alanlarına bağlanır. Eşlemeyi panelde Eşleştirme adımında ya da bağlantınınfield_mapping alanında {source, target} çiftleri olarak tanımlarsınız (en fazla 200 satır). target değeri aşağıdaki anahtarlardan biri olmalıdır. Bu listeye GET /api/v1/integration-entities ile de ulaşırsınız.
Metin alanları 255 karaktere kısaltılır. Eşlenmeyen sütunlar Lead’e yazılmaz; ham veri yine de kaydın Gelen Veri görünümünde saklanır.
Kimlik alanı zorunluluğu
Bağlantıyı etkinleştirmek için eşlemede şu beş alandan en az biri olmalıdır:full_name, first_name, last_name, phone_number, email. Aksi halde etkinleştirme 422 INTEGRATION_CONNECTION_MAPPING_INCOMPLETE döndürür; yanıttaki data.identity_fields bu alanları listeler. Bir kayıtta bu alanların hiçbirinde kullanılabilir değer yoksa kayıt Hatalı olur.
Kayıt kimliği ve tekrarlayan kayıtlar
Gönderen sistemin kendi kayıt kimliğini (örneğin yukarıdakiid) bağlantının external_id_path alanına yazarsanız aynı kimlikle gelen kayıt yeni Lead açmaz, daha önce oluşan Lead’i günceller. Güncellemede eşlenen tüm değerler üzerine yazılır; Lead’in aşaması, atananı ve kaynağı değişmez. Kimlik yolu tanımlı değilse tekrarlayan kayıtlar yalnızca telefon ya da e-posta eşleşmesiyle birleşir.
Yeni kayıt şu sırayla işlenir:
- Aynı klinikte aynı telefon, yoksa aynı e-posta ile silinmemiş bir Lead varsa kayıt o Lead ile birleştirilir: yalnızca boş alanlar doldurulur.
- Eşleşme yoksa yeni Lead oluşturulur ve ona bağlı bir hasta kaydı açılır.
Bağlantı ayarları
Bağlantınınsettings alanı Lead’in nereye düşeceğini belirler. Hepsi isteğe bağlıdır; boş bırakılan ayar varsayılanı kullanır.
Seçilen aşama, kaynak ya da kullanıcı sonradan geçersiz olursa (örneğin pipeline pasife alınırsa) işlem hata vermez, varsayılan davranış uygulanır. Aşama seçimleri yalnızca aktif pipeline’a ait olabilir; bkz. Pipeline’lar.
Yanıtlar ve oran sınırı
Başarılı istekte yanıt202 Accepted olur ve kabul edilen kayıt sayısını içerir.
Oran sınırı
Her bağlantı için dakikada 120 istek gönderebilirsiniz. Sınır, bağlantınınuuid değerine göre sayılır; aynı bağlantıya birden fazla sistemden gönderim yapsanız da toplam sayılır. Sınır aşılırsa 429 TOO_MANY_REQUESTS alırsınız. Yanıttaki Retry-After başlığı beklemeniz gereken saniyeyi söyler. Genel kurallar için Oran sınırları sayfasına bakın.
Çok sayıda kaydı tek tek göndermek yerine istek başına 500 kayda kadar dizi olarak gönderin.
Hatalar ve yeniden deneme
İstek hataları
Bu hatalar istek aşamasında döner ve hiçbir kayıt saklanmaz.Kayıt işleme hataları
Kabul edilen bir kayıt sonradan işlenemeyebilir. Bu durum202 yanıtında görünmez; kaydın durumundan okunur. Bağlantının Gelen Kayıtlar sekmesinden ya da GET /api/v1/integration-connections/{id}/records ile izleyin. Kayıt durumları: pending (Bekliyor), processed (İşlendi), failed (Hatalı), skipped (Atlandı). İşlenen kayıtta outcome değeri created, updated veya merged olur.
Yeniden deneme
- Hatalı kayıtlar eşlemeyi düzelttikten sonra yeniden denenir: panelde Hatalıları Yeniden Dene ya da satırdaki Yeniden Dene, API’de
POST /api/v1/integration-connections/{id}/records/retry. Gövdedekirecord_ids(en fazla 500) isteğe bağlıdır; vermezseniz bağlantının tüm hatalı kayıtları denenir. Yanıt{"queued": n}biçimindedir. Yalnızcafailedkayıtlar etkilenir. - Bekleyen kayıtlar bağlantıyı etkinleştirince (
POST /api/v1/integration-connections/{id}/activate) işlenir. - Eşlemeyi kaydetmek işlenmiş kayıtları yeniden işlemez.
- Gönderen taraf
429yanıtındaRetry-Aftersüresi kadar bekleyip aynı isteği yeniden göndermelidir.401,404,413ve422için isteği değiştirmeden tekrar göndermek sonuç vermez; nedeni düzeltin.
İlgili sayfalar
Panelden bağlantı kurma
Zapier kurulumu, alan eşleme ve gelen kayıtları izleme.
Entegrasyonlar kaynağı
Bağlantıları API ile yönetme.
Lead'ler
Oluşan Lead kayıtlarını okuma.
Oran sınırları
429 yanıtı ve bekleme önerileri.