Senaryo
Web sitenizdeki bir form doldurulur. Entegrasyonunuz şu adımları izler: ÖrneklerdeAyş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.
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_idgö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_valuegöndermezseniz, seçtiğiniz tedavilerin fiyatlarının toplamı kullanılır.assigned_user_idboş 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:Leadiznine sahip değilse amaView:LeadveReceiveLeads:Leadizinleri 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ıttakistages dizisinde her aşamanın stage.id, stage.name, stage.is_won ve stage.is_lost alanları bulunur.
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_reasongöndermeniz gerekebilir. Kayıp aşaması neden istiyorsa ve göndermezsenizLEAD_LOST_REASON_REQUIREDalırsınız. Bunun yerinePOST /leads/{id}/lostda 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.
Atama
Önce Lead’i alabilecek kullanıcıları listeleyin. Yanıtta yalnızcaReceiveLeads:Lead iznine sahip, kliniğin aktif kullanıcıları yer alır; email alanı yalnızca Assign:Lead iznine sahip çağıranlara döner.
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:leads:write ve customers:write scope’larının ikisini birden ister.
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_existingile 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_idgö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.Hata durumları
Hata gövdesi{"success": false, "error_code": "...", "message": "..."} biçimindedir. Genel kurallar için Hata kodları sayfasına bakın.