/v1/tenant), yeni kliniklerin kurulum sihirbazı (/v1/setup-wizard), hasta ve Lead’lerde genel arama (/v1/general/global-search) ve tüm kliniklerde ortak olan arama listeleri (/v1/general/*). Klinik profili ve arama X-Tenant ister. Ortak listeler istemez.
Endpoint özeti
Tüm isteklerAuthorization: Bearer <access_token> başlığı taşır. Klinik bağlamı için Klinikler ve X-Tenant, scope’lar için Scope’lar sayfasına bakın.
Yetki
İzin ve scope eksikliği
403 FORBIDDEN döndürür. Yeni kliniklerde Manage:SetupWizard izni yalnızca super_admin rolündedir. Diğer roller için rol düzenleyicisinden ekleyin. İzinlerin nasıl değerlendirildiği için İzinler ve görünürlük sayfasına bakın.
Klinik profili
GET /v1/tenant yanıtı { "success": true, "data": { ... } } zarfındadır.
PUT /v1/tenant kısmi güncellemedir: yalnızca gönderdiğiniz alanlar yazılır.
Klinik adı, logo, şehir, ilçe, ülke ve vergi bilgileri bu endpoint ile değiştirilemez. Klinik adını yalnızca kurulum sırasında
PUT /v1/setup-wizard/clinic-info ile kaydedebilirsiniz.Çalışma saatleri
work_hours haftanın yedi gününü içerir. Saatleri klinik saat diliminde gönderir ve okursunuz. Sistem bunları UTC olarak saklar, siz dönüşümle uğraşmazsınız.
Çalışma saatlerini kaydettiğinizde klinik önbelleği temizlenir. AI asistan ve randevu uygunluğu yeni saatleri hemen kullanır.
Kurulum sihirbazı
Yeni bir klinik, zorunlu kurulum adımlarını bitirene kadar kurulum kilidi altındadır. Bu sürede kilit muafiyeti olmayan her klinik endpoint’i428 SETUP_REQUIRED döndürür. Gövdede data.next_step sıradaki adımı verir. Kilidin genel anlatımı için Erişim kilitleri sayfasına bakın.
Kilit altında şu endpoint grupları çalışmaya devam eder: setup-wizard, billing, tenant, account, notifications, general, settings, files, uploads, permissions, roles, users, invitations, occupations, channels, integrations, integration-connections, doctors, assistants, rooms, treatments, treatment-groups, form-templates, products, catalog-products, product-brands, product-categories, warehouses, invoices/accounts, invoices/series, bank-accounts, payment-methods, tickets, panel-tickets. Randevu, hasta, Lead, sohbet, satış, fatura ve etiket endpoint’leri kurulum bitene kadar 428 verir.
Faturalama kilidi kurulum kilidinden önce değerlendirilir. Süresi dolmuş abonelikte
402 SUBSCRIPTION_REQUIRED alırsınız, 428 almazsınız.Adımlar
Çalışma modu 1 randevu akışını, mod 2 ön kayıt formu akışını seçer. Sihirbaz yalnızca ilerlemeyi tutar. Kanal, doktor, tedavi, oda gibi kayıtları normal endpoint’lerle siz oluşturursunuz, sonra adımı
complete ile onaylarsınız.
Yanıt
GET /v1/setup-wizard şu alanları döndürür.
completed ile ready birbirinden bağımsızdır. Kayıtlar var ama adım onaylanmamış olabilir. Tersi de olur: adımı onayladıktan sonra kaydı silmiş olabilirsiniz. missing[] içindeki değerler eksik alanın veya kaydın makine adıdır, örneğin active_channel, active_doctor, active_treatment_group.
Klinik bilgileri
PUT /v1/setup-wizard/clinic-info gövdesi:
Çalışma modu
PUT /v1/setup-wizard/work-mode gövdesi work_mode (zorunlu, 1 veya 2) ve default_template_id alanlarını alır. default_template_id yalnızca mod 2’de kullanılır ve bu kliniğe ait aktif bir Form Şablonu olmalıdır; başka kliniğin şablonu 422 verir. Mod 2’de şablon göndermezseniz sistem Varsayılan Ön Kayıt Formu şablonunu oluşturur veya yeniden kullanır. Mod 1’de gönderdiğiniz şablon yok sayılır.
Modu sonradan değiştirebilirsiniz. Yeni modun tamamlanmamış adımı varsa setup_required yeniden true olur.
Adım ve kurulum tamamlama
POST /v1/setup-wizard/steps/{step}/completeadımın kayıtlarını doğrular ve adımı tamamlar. Kayıtlar eksikse422 SETUP_STEP_INCOMPLETEdöner vedataiçindestepilemissing[]bulunur.POST /v1/setup-wizard/steps/{step}/skipyalnızca isteğe bağlı adımlar (room_assistant,invoice_integration,bank_accounts) içindir. Kayıtları kontrol etmez.POST /v1/setup-wizard/doctor/selfoturum açmış kullanıcıya kliniktekidoctorrolünü ek olarak verir ve ek kullanıcı hakkı harcamaz. Tek kullanıcılı kliniklerde mod 1 kurulumunu bitirmenin yoludur. Adımı tamamlamaz; ardındansteps/doctor_setup/completeçağırın.POST /v1/setup-wizard/completezorunlu adımları güncel kayıtlara göre yeniden doğrular. Daha önce tamamladığınız bir adımın kaydını silmişseniz422 SETUP_INCOMPLETEdöner vedata.blockers[]eksikleri listeler. Başarılı olursais_completedvesetup_requireddeğerleritruevefalseolur.
Genel arama
GET /v1/general/global-search tek istekte hasta ve Lead arar. search zorunludur (1–255 karakter).
Ortak listeler ve döviz kurları
/v1/general/* listeleri tüm kliniklerde aynıdır. X-Tenant ve scope gerekmez; geçerli bir bearer token yeterlidir. Bu yüzden klinik seçilmeden önce, örneğin kayıt ve adres formlarında kullanabilirsiniz. Tarihler bu isteklerde UTC döner.
Ortak parametreler:
Yanıt sayfalı listedir (
data, links, meta); success anahtarı yoktur. Genel kurallar için Sayfalama ve Filtreleme ve sıralama sayfalarına bakın. Ülke ve para birimi adları Türkçedir.
Döviz kurları
exchange-rates kayıtları Türkiye Cumhuriyet Merkez Bankası (TCMB) günlük kurlarından gelir ve iş günlerinde güncellenir. Her para birimi için günde bir kayıt vardır; en yeni tarih başta gelir.
currency_id değerlerini /v1/general/currencies listesinden alın. Finans tarafı için Hesaplar ve işlemler sayfasına bakın.
Hata kodları
Bilinmeyen bir
{step} değeri 404 döndürür. Tüm hata kodları için Hata kodları sayfasına bakın.