Authorization: Bearer <access_token> ve X-Tenant: <tenant_id> başlıkları gerekir. Taban adres https://app.flextell.ai/api/v1 şeklindedir.
Endpoint özeti
AI raporları
Rapor planları
Kullanıcılar varsayılan olarak yalnızca kendi oluşturdukları raporları görür. Kliniğin tüm raporlarını listelemek, yeniden oluşturmak, indirmek veya silmek için
ViewAllAIReports:AIReport (Tümünü Görüntüle) izni gerekir. Planlarda sahiplik süzgeci yoktur; View:AIReportSchedule izni olan herkes kliniğin tüm planlarını görür. Genel kurallar için izinler ve görünürlük ve scope’lar sayfalarına bakın.Rapor nesnesi
Rapor oluşturma işi arka planda çalışır.POST yanıtı pending durumunda bir rapor döndürür; sonucu GET /ai-reports/{id} ile status alanını izleyerek alırsınız.
Durum akışı
pending → running → completed şeklindedir. Hata olursa rapor failed olur; durumu API’den elle değiştiremezsiniz.
Dönem etiketleri
Dönemler klinik saat dilimine göre çözülür. Karşılaştırma dönemi, önceki eşdeğer penceredir.
this_week, this_month ve this_year için önceki dönem, geçen sürenin aynı uzunluğuna kısaltılır.
Rapor oluşturma
POST /ai-reports isteği raporu hemen kaydeder, 202 ile status: "pending" döner ve üretimi kuyruğa alır.
Modüller
systems alanı aşağıdaki değerleri kabul eder. Tüm modüller için ["all"] gönderin.
Yeniden oluşturma
POST /ai-reports/{id}/recreate gövde almaz. Kaynak raporun modüllerini, dönem etiketini, başlığını ve özel aralık tarihlerini kopyalayan yeni bir pending rapor döndürür.
- Kayan dönemler yeniden çözülür.
last_7_daysraporunu bugün yeniden oluşturursanız bugünün son 7 günü alınır. - Yeni raporun sahibi, kaynak raporun sahibi değil isteği yapan kullanıcıdır.
- İstek idempotent değildir; her çağrı yeni bir rapor oluşturur.
Listeleme
GET /ai-reports genel sayfalama ve filtreleme ve sıralama kurallarını izler. Bu kaynağa özgü parametreler:
Metin araması yoktur. Liste her durumdaki raporu (
pending, running, failed dahil) döndürür.
Sonuç yapısı
Şablonlu (structured) raporlarda sonuç result_data içindedir ve version: 2 şemasını kullanır. Bu alan hazır HTML içermez; belgeyi kendiniz çizebilir ya da PDF’i indirebilirsiniz.
Metrik değer biçimleri
92 noktadan uzun günlük seriler haftalık gruplara sıkıştırılır.
Özet davranışı
- Dönemde hiç etkinlik yoksa AI çağrılmaz;
narrative.statusskippedolur. - Özet üretilemezse rapor yine
completedolur.narrative.statusfaileddöner ve sayısal bölümler eksiksizdir. - Özet 2–3 cümledir (tek günlük dönemlerde 1–2); tam 3 öneri içerir (tek günlük dönemlerde 2).
- Önceki dönem kliniğin kuruluşundan öncesini kapsıyorsa karşılaştırma kısmidir.
GET /ai-reports/{id}/pdf A4 dikey PDF döndürür. PDF ilk indirmede hazırlanır, birkaç saniye sürebilir ve sonra saklanır. İndirme için View değil, Download:AIReport izni gerekir.
Hatalar
Rapor üretimi sırasında oluşan hatalar HTTP yanıtı değil,
status: "failed" ve error_message ile görünür:
Rapor oluşturulurken bir hata oluştu. Sorun sürerse sistem yöneticinize başvurun.Örneğin 731 günden uzun bir özel aralık bu hatayla biter;POSTisteği bu süreyi doğrulamaz.Rapor oluşturulamadı: talebi yapan kullanıcının bu klinikte rapor oluşturma yetkisi kalmamış.Rapor çalışmaya başladığında isteyen kullanıcı kliniğe ait olmalı ve hâlâCreate:AIReportiznine sahip olmalıdır.
Rapor planları
Plan, belirlenen zamanda sizin adınızaPOST /ai-reports çağırmak gibi çalışır. Plan, raporu oluşturan kullanıcıya ait olur ve plan adı rapor başlığı olur. Yeni klinikler için üç varsayılan plan kapalı (is_active: false) gelir: Günlük Özet, Haftalık Özet ve Aylık Özet. Bu planların sahibi yoktur; ürettikleri raporları yalnızca ViewAllAIReports:AIReport izni olanlar görür ve kimseye bildirim gitmez.
Plan nesnesi
Çalışma zamanı kuralları
follows_work_hoursaçıkken çalışma saati, o günün kapanış saatidir. Kapalı günlerde plan çalışmaz.starts_atyoksa vefollows_work_hourskapalıysadailyplan her gün,weeklyplan pazartesi,monthlyplan ayın 1’inde çalışır.follows_work_hoursaçıksadailyplan her açık günde,weeklyplan haftanın,monthlyplan ayın son çalışma gününde çalışır.starts_atvarsaweeklyplan o tarihin haftanın gününde,monthlyplan ayın o gününde çalışır. Ay o günü içermiyorsa ayın son gününe çekilir. Plan başlangıç tarihinden önce çalışmaz. Çalışma saatleri açıkken o gün kapalıysa plan, aynı hafta veya ay içindeki en yakın açık güne kayar.- Plan her zaman en fazla bir kez çalışır; zamanlayıcı geç kalsa bile aynı gün içinde yakalar.
- Plan kaydedilince
next_run_atyeniden hesaplanır. Kapalı plandanullolur.
Plan örneği
201 döner. PUT isteğinde tüm alanlar isteğe bağlıdır; timezone güncellemede null olamaz. Listeleme name, frequency, is_active, last_run_at, next_run_at, created_at alanlarıyla sıralanır (varsayılan created_at, yeniden eskiye) ve frequency, period_label, is_active, user_id, systems[] ile aralık filtrelerini destekler. Bulunamayan plan için 404 RESOURCE_NOT_FOUND ve AI rapor planı bulunamadı döner.
Kredi kullanımı
AI raporları SMS veya WhatsApp kredisi harcamaz. Raporun özet kısmı için yapılan AI çağrıları, aboneliğinizin yapay zekâ kullanım hakkına yazılır ve faturalamada Yapay zekâ raporu kalemi altında görünür. Kredi türleri için krediler, abonelik ve kullanım için abonelik ve faturalama sayfalarına bakın. Abonelik bitmişse veya kullanım hakkı dolmuşsa AI çağrısı reddedilir. Rapor yine de tamamlanır; sayısal bölümler gelir,narrative.status failed olur.
Erişim kilitleri hakkında ayrıntı için erişim kilitleri sayfasına bakın.