Skip to main content
Bu rehber, bir Lead’in Flextell’e girişinden hastaya dönüşmesine kadar olan yolu API çağrılarıyla gösterir. Reklam formu, CRM veya özel bir yazılımla Lead topluyorsanız aynı sırayı izleyebilirsiniz. Her uç noktanın tüm alanları için Lead’ler kaynak sayfasına bakın.

Senaryo

Web sitenizdeki bir form doldurulur. Entegrasyonunuz şu adımları izler: Örneklerde Ayşe Yılmaz adlı örnek bir kişi kullanılır. Tüm isteklerde Authorization: Bearer <access_token> ve X-Tenant: <tenant_id> başlıkları gerekir. Başlıklar için Klinikler ve X-Tenant sayfasına bakın.
Bir kullanıcı, ViewAllLeads:Lead izni yoksa yalnızca kendisine atanmış Lead’leri görür. Lead’i kendi oluşturmuş olması görünürlük sağlamaz. Ayrıntılar için İzinler ve görünürlük sayfasına bakın.

Lead oluşturma

POST /api/v1/leads isteğinde hiçbir alan zorunlu değildir, ancak en azından ad ve telefon göndermeniz önerilir. phone_number sunucuda ülke kodlu rakamlara çevrilir ve kliniğin canlı Lead’leri arasında benzersiz olmalıdır. Telefonu mevcut bir hastayla eşleşirse yeni Lead o hastanın kaydına bağlanır; yinelenen kayıt oluşmaz.
Yanıt 201 ile döner ve oluşan Lead’i içerir. Sonraki adımlarda kullanacağınız id değerini saklayın. Oluşturma sırasında şu kurallar işler:
  • pipeline_stage_id göndermezseniz Lead, aktif pipeline’ın giriş aşamasına (varsayılan kurulumda Yeni) düşer. Gönderirseniz aşama aktif pipeline’a ait olmalıdır.
  • expected_value göndermezseniz, seçtiğiniz tedavilerin fiyatlarının toplamı kullanılır.
  • assigned_user_id boş bırakılırsa ve kliniğiniz otomatik atama kullanıyorsa Lead, oluşturma anında bir satış temsilcisine atanabilir. Bu davranış kliniğinizin ayarlarına göre değişir.
  • Oluşturan kullanıcı Assign:Lead iznine sahip değilse ama View:Lead ve ReceiveLeads:Lead izinleri varsa (örneğin bir satış temsilcisi) Lead kendisine atanır.

Aşama değiştirme

Aşama kimliklerini almak için aktif pipeline’ın özetini çekin. Yanıttaki stages dizisinde her aşamanın stage.id, stage.name, stage.is_won ve stage.is_lost alanları bulunur.
Aşamayı PUT /api/v1/leads/{id} ile değiştirin:
  • Hedef aşama, aktif pipeline’ın aşaması olmalıdır.
  • Kayıp aşamasına taşırken lost_reason göndermeniz gerekebilir. Kayıp aşaması neden istiyorsa ve göndermezseniz LEAD_LOST_REASON_REQUIRED alırsınız. Bunun yerine POST /leads/{id}/lost da kullanabilirsiniz.
  • Kayıp aşamasından başka bir aşamaya taşımak Lead’i yeniden açar; kayıp nedeni ve tarihi temizlenir.
  • Dönüştürülmüş bir Lead’in aşaması değiştirilemez.
PUT /leads/{id} ile assigned_user_id değiştirmek yalnızca sahibi değiştirir. Açık görevler ve notlar yeni sahibe geçmez. Atama için bir sonraki bölümdeki assign uç noktasını kullanın.
Aşamaların kendisini (ekleme, sıralama, aktif pipeline’ı değiştirme) yönetmek için Pipeline’lar sayfasına bakın.

Atama

Önce Lead’i alabilecek kullanıcıları listeleyin. Yanıtta yalnızca ReceiveLeads:Lead iznine sahip, kliniğin aktif kullanıcıları yer alır; email alanı yalnızca Assign:Lead iznine sahip çağıranlara döner.
Sonra atamayı yapın:
task_action, Lead’in açık görevlerine ne olacağını belirler: Yanıt lead ve cap_exceeded alanlarını içerir. Yeni sahip AutoAssignLeads:Lead iznine sahipse ve kliniğindeki aktif Lead sayısı sınırına ulaşmışsa cap_exceeded true olur. Atama yine de yapılır; yanıt yalnızca uyarır. Birden çok Lead’i tek seferde atamak için POST /leads/bulk-assign kullanılır. Panelden atama için Atama sayfasına bakın.

Kazanıldı ve dönüştürme

Dönüştürme yalnızca kazanıldı aşamasındaki Lead’lerde çalışır. Önce Lead’i kazanıldı olarak işaretleyin:
Ardından hastaya dönüştürün. Bu istek leads:write ve customers:write scope’larının ikisini birden ister.
Yanıt, dönüşümün nasıl sonuçlandığını gösteren bir result alanı, oluşan veya eşleşen customer kaydını ve güncel lead kaydını içerir.
  • Dönüştürme tekrarlanabilir. Zaten dönüştürülmüş bir Lead için istek, aynı hastayı matched_existing ile döndürür.
  • Lead’in notları ve dosyaları hastaya kopyalanır. Görevler kopyalanmaz; hastanın kaydında Lead üzerinden görünür.
  • Geri alma (hastayı yeniden Lead yapma) yoktur.
  • Elinizde belirli bir hasta kaydı varsa existing_customer_id göndererek Lead’i o hastaya bağlayabilirsiniz. API ile oluşturulan Lead’lerin çoğunda gerekmez.
  • Dönüşümden sonra Lead’in sahibi sabitlenir; assign çağrısı reddedilir.
Kliniğiniz otomatik dönüştürme kullanıyorsa Lead, randevu veya satış oluşturulduğunda kendiliğinden hastaya dönüşebilir. Bu durumda convert çağrısına gerek kalmaz. Dönüşmemiş bir Lead için fatura veya tahsilat işlemi oluşturmak (satış otomatik dönüştürme tetikleyicisi değilse satış da) LEAD_FINANCIAL_BLOCKED (422) hatası verir; önce Lead’i dönüştürün.
Panel karşılığı için Hastaya dönüştürme sayfasına, dönüşen kaydın hasta tarafı için Hastalar sayfasına bakın.

Hata durumları

Hata gövdesi {"success": false, "error_code": "...", "message": "..."} biçimindedir. Genel kurallar için Hata kodları sayfasına bakın.
LEAD_NOT_ASSIGNED alırsanız Lead’i yeniden denemek yerine data.assigned_user ile sahibini bulun ve gerekirse Lead’i çağıran kullanıcıya atatın ya da kullanıcıya ViewAllLeads:Lead izni verin.