Flextell API'ye giriş

Flextell API, panelde ve mobil uygulamada yaptığınız işlemlerin çoğunu kendi yazılımınızdan yapmanızı sağlar. Bu sayfa entegrasyon geliştiricileri içindir. API’nin kapsamını, istek akışını ve belgeler arasında nasıl gezineceğinizi özetler.

API ile neler yapılabilir

API, bir kliniğin günlük çalışmasındaki temel kaynakları REST uç noktaları olarak sunar. Tüm yollar /api/v1 önekiyle başlar. v2 yoktur, değişiklikler v1 içinde yayımlanır.

Hastalar ve Lead'ler

Hasta ve Lead kayıtlarını oluşturun, güncelleyin, not ve görev ekleyin, Pipeline aşamalarında ilerletin.

Randevular

Randevu oluşturun, uygun saatleri sorgulayın, hatırlatmaları ve tatilleri yönetin.

Sohbetler ve mesajlar

Kanallardan gelen Sohbetleri okuyun, mesaj ve medya gönderin, AI asistanı denetleyin.

Satış, tahsilat ve fatura

Satış kaydedin, tahsilat alın, fatura ve stok verilerine erişin.

Bunların dışında dosya yükleme, bildirimler, ayarlar, istatistikler ve Geri Dönüşüm Kutusu gibi kaynaklar da vardır. Tam liste için sol menüdeki Kaynak Rehberleri grubuna bakın. API üç ek yol daha sunar:

Gerçek zamanlı olaylar: Yeni mesaj, Sohbet ve Hasta değişikliklerini Pusher protokolüyle dinlersiniz. Bkz. Gerçek zamanlı olaylar.
Webhook’lar: Dış sistemlerden Flextell’e Lead gönderirsiniz. Bkz. Gelen Lead webhook’u.
Kanal entegrasyonları: WhatsApp, Telegram ve e-Fatura bağlantılarını yönetirsiniz. Bkz. Entegrasyonlara genel bakış.

Erişim modeli

Her istek aynı üç adımdan geçer: kimliğiniz doğrulanır, çalışacağınız klinik seçilir, sonra yetkiniz denetlenir.

Adım	Ne yapar	Nasıl sağlarsınız
Kimlik doğrulama	OAuth 2.0 ve OpenID Connect kullanır. Kimlik sunucusu `https://id.flextell.ai` adresindedir.	`Authorization: Bearer <access_token>` başlığı
Klinik seçimi	Aynı kullanıcı birden fazla kliniğe üye olabilir. API hangi klinikte çalışacağınızı sizden bekler.	`X-Tenant: <tenant_id>` başlığı
scope	Uygulamanızın hangi kaynaklara erişebileceğini belirler.	Uygulamayı oluştururken seçtiğiniz scope listesi
İzin	İşlemi yapan kullanıcının o klinikteki rol izinlerini uygular.	Kullanıcının rolü

Etkin yetki, token scope’ları ile kullanıcının o klinikteki izinlerinin kesişimidir. Uygulamanız kullanıcının yapamadığı bir işi yapamaz. Aynı biçimde kullanıcı izin verse bile token’da gerekli scope yoksa istek 403 döner.

Kullanıcının üye olmadığı ya da var olmayan bir klinik için 404 TENANT_NOT_FOUND döner, 403 dönmez. Başlık hiç yoksa 400 TENANT_HEADER_REQUIRED alırsınız. Kliniklerin listesi için GET /account/tenants çağrısını kullanın. Ayrıntı için Klinikler ve X-Tenant sayfasına bakın.

Uygulama kaydı ve token’lar

Uygulamanızı panelde Bağlantılar → Uygulamalar → Uygulama Oluştur yoluyla ya da /oauth/clients uç noktalarıyla kaydedersiniz. Uygulama bir Client ID ve gizli bir Client Secret alır. Secret yalnızca bir kez gösterilir.
Kullanıcıdan yetki almak için yetkilendirme kodu akışını ve PKCE’yi kullanırsınız. Kullanıcı Flextell giriş ekranında oturum açar ve uygulamanıza izin verir.
Access token 5 dakika geçerlidir. Refresh token 7 gün geçerlidir ve her kullanımda yenisiyle değişir. Süresi dolan token ile yapılan istek 401 UNAUTHENTICATED döner.

Akışın tamamı için Kimlik doğrulamaya genel bakış sayfasından başlayın.

Görünürlük, abonelik ve kurulum

İzin vermediğiniz bir kayıt bulunamadıysa API çoğunlukla 404 döner. Kaydın var olduğu sızdırılmaz. ViewAllConversations izni olmayan kullanıcılar, örneğin varsayılan satış temsilcisi rolü, yalnızca kendilerine atanmış Lead’lerin Sohbetlerini görür. Ayrıntı için İzinler ve görünürlük sayfasına bakın.
Kliniğin aboneliği bittiyse 402, zorunlu kurulum adımları açıksa 428 döner. Bkz. Erişim kilitleri.
İstekler kullanıcı ve uygulama başına dakikada 300 ile sınırlıdır. Bkz. Oran sınırları.

Temel kavramlar

Uygulama (OAuth istemcisi)

Entegrasyonunuzun Flextell’deki kimliğidir. Bir Client ID, bir Client Secret, yönlendirme URI’leri ve scope listesi içerir. Her ortam için ayrı uygulama oluşturun.

Klinik (tenant)

Verinin ait olduğu kuruluştur. API’de tenant, istek başlığında X-Tenant adıyla geçer. Hastalar, randevular ve diğer tüm klinik kayıtları yalnızca seçilen klinikte görünür.

scope

Token’ın erişebileceği kaynak ve işlemdir. Biçimi kaynak:okuma-ya-da-yazma şeklindedir, örneğin customers:read. Bir endpoint’in hangi scope’u istediğini ilgili kaynak sayfasında bulursunuz. Bkz. scope’lar.

İzin

Kullanıcının rolünden gelen yetkidir, örneğin View:Customer. scope uygulamayı, izin kullanıcıyı sınırlar. İkisi birlikte gerekir.

Yanıt zarfı

Başarılı yanıtlar { "success": true, "data": ... } biçimindedir. Hatalar { "success": false, "error_code": "...", "message": "..." } döner. Doğrulama hatalarında errors alanı alan alan ayrıntı verir. Bkz. Yanıt yapısı.

Tek bir isteğin nasıl göründüğü:

curl "https://app.flextell.ai/api/v1/customers?per_page=15" \
  -H "Authorization: Bearer <access_token>" \
  -H "X-Tenant: <tenant_id>" \
  -H "Accept: application/json" \
  -H "Accept-Language: tr"

Bu çağrı customers:read scope’unu ve klinikte View:Customer iznini gerektirir. Accept-Language isteğe bağlıdır ve tr ya da en alır. Başka bir değer gönderirseniz yanıt Türkçe döner.

Belgeleri okuma

Bu bölümdeki sayfalar sırayla okunacak şekilde dizilmiştir.

Menü grubu	Ne bulursunuz
Başlarken	Bu giriş, hızlı başlangıç ve ortamlar
Kimlik Doğrulama	Uygulama oluşturma, yetkilendirme kodu ve PKCE, token’lar, scope’lar, OpenID Connect, hatalar
Çok Kiracılılık	Klinik seçimi ve izinler
İstek Kuralları	Başlıklar, sayfalama, filtreleme ve sıralama, veri biçimleri, hata kodları, oran sınırları, idempotency, dosya yükleme
Kaynak Rehberleri	Her kaynak için uç nokta özeti, nesne alanları, iş kuralları, hata kodları, izinler ve örnekler
Gerçek Zamanlı, Webhook’lar ve Açık Uçlar, Entegrasyonlar	Canlı olaylar, gelen webhook’lar, kanal bağlantıları
Rehberler	Uçtan uca senaryolar, örneğin randevu oluşturma ve Lead akışı

Önerilen sıra:

Ortamı seçin

Ortamlar sayfasından üretim ve geliştirme adreslerini alın. Ortamlar arasında secret paylaşmayın.

İlk isteği yapın

Hızlı başlangıç uygulama oluşturmadan ilk klinik çağrısına kadar götürür.

Ortak kuralları okuyun

Başlıklar, sayfalama ve hatalar tüm kaynaklarda aynıdır. Kaynak sayfaları bunları tekrar etmez, bağlantı verir.

Kaynağınıza geçin

İhtiyacınız olan kaynağın sayfasını açın.

Kaynak sayfalarındaki tablolar ve örnekler panelde göreceğiniz Türkçe adları kullanır. API alan adları, scope’lar ve hata kodları ise olduğu gibi yazılır. Bazı terimler API’de İngilizce kalır, örneğin conversation. Terimlerin karşılıkları için Sözlük sayfasına bakın.

API referansı

API Referansı sekmesi OpenAPI belirtiminden otomatik üretilir. Her endpoint için parametreleri, istek gövdesini ve yanıt şemasını verir, istekleri deneyebilirsiniz. Elle yazılmış API sekmesi ise kavramları, iş kurallarını ve senaryoları anlatır. Bir endpoint’in ne yaptığını anlamak için önce API sekmesindeki kaynak sayfasını, alan ayrıntısı için API Referansı sekmesini kullanın.

OpenAPI belirtimindeki OAuth bölümü yalnızca * scope’unu gösterir. Gerçek scope listesi için scope’lar sayfasını kullanın.

Sorunuz çözülmediyse Destek sayfasına bakın.

Başlarken

Kimlik Doğrulama

Çok Kiracılılık

İstek Kuralları

Kaynak Rehberleri

Gerçek Zamanlı

Webhook'lar ve Açık Uçlar

Entegrasyonlar

Rehberler

Kaynaklar

Flextell API'ye giriş

API ile neler yapılabilir

Hastalar ve Lead'ler

Randevular

Sohbetler ve mesajlar

Satış, tahsilat ve fatura

Erişim modeli

Uygulama kaydı ve token’lar

Görünürlük, abonelik ve kurulum

Temel kavramlar

Belgeleri okuma

API referansı

​API ile neler yapılabilir

Hastalar ve Lead'ler

Randevular

Sohbetler ve mesajlar

Satış, tahsilat ve fatura

​Erişim modeli

​Uygulama kaydı ve token’lar

​Görünürlük, abonelik ve kurulum

​Temel kavramlar

​Belgeleri okuma

​API referansı

API ile neler yapılabilir

Erişim modeli

Uygulama kaydı ve token’lar

Görünürlük, abonelik ve kurulum

Temel kavramlar

Belgeleri okuma

API referansı