Skip to main content
Flextell API’si iki ortamda çalışır: canlı ve test. Her ortamın iki adresi vardır: istekleri gönderdiğiniz API adresi ve token aldığınız kimlik sunucusu. Entegrasyonunuzu yazarken bu iki adresi aynı ortamdan seçin.

Ortamlar

Entegrasyonunuzu önce test ortamında deneyin. Adresleri koda gömmek yerine ortam değişkeni veya yapılandırma dosyasında tutun. Böylece ortam değiştirmek için tek bir değeri güncellemeniz yeterli olur.

API adresi

Tüm kaynak uç noktaları API adresinin altındadır. Bu dokümandaki örnekler canlı adresi kullanır.
Her istekte Authorization başlığı gerekir. Klinik verisine erişen uç noktalarda ayrıca X-Tenant: <tenant_id> başlığını gönderin. Başlıkların tam listesi için İstek başlıkları ve Klinikler ve X-Tenant sayfalarına bakın. API adresiyle aynı makinede kimlik doğrulaması gerektirmeyen birkaç yol da bulunur: Bu yollar /api/v1 önekini taşımaz. Örneğin canlı ortamda sağlık denetimi https://app.flextell.ai/up adresindedir.

Kimlik sunucusu

Token’ları kimlik sunucusundan alırsınız. API adresi ise yalnızca bu token’ları kabul eder. Kimlik sunucusunun başlıca adresleri: Canlı ortamda yetkilendirme adresi https://id.flextell.ai/oauth/authorize, token adresi https://id.flextell.ai/oauth/token olur. Test ortamında id.flextell.ai yerine iddev.flextell.ai yazın. Keşif belgesi desteklenen yetkilendirme akışlarını, imza algoritmasını ve scope listesini bildirir. İstemci kitaplığınız keşif belgesini okuyabiliyorsa yalnızca kimlik sunucusunun adresini vermeniz yeterlidir.
Yetkilendirme ve token isteklerini her zaman kimlik sunucusuna gönderin (id.flextell.ai veya iddev.flextell.ai). API adresi olan app.flextell.ai ve dev.flextell.ai üzerinde de eski OAuth yolları görünebilir. Yeni entegrasyonlarda bunları kullanmayın.
Akışın adımları için Kimlik doğrulama genel bakış ve OpenID Connect sayfalarına geçin.

Sürüm öneki

Tüm kaynak uç noktaları /api/v1 önekiyle başlar. Şu anda tek sürüm v1’dir; v2 yoktur.
Önek yalnızca REST kaynaklarını kapsar. Şu yollar sürümsüzdür:
Kırıcı değişiklikler yeni bir sürüm numarasıyla değil, v1 içinde yayımlanır. Yanıtlarda Deprecation veya Sunset başlığı yoktur. Değişiklikleri API değişiklikleri sayfasından takip edin. Sürümleme ilkesinin ayrıntısı Sürümleme sayfasındadır.

API referansı ve OpenAPI belgesi

Her uç noktanın parametrelerini, şemalarını ve yanıtlarını OpenAPI belgesinde bulursunuz. Belge herkese açıktır; erişmek için token gerekmez. OpenAPI belgesini Postman, Insomnia gibi araçlara aktarabilir veya istemci kodu üretmek için kullanabilirsiniz. Belgede sunucu adresi https://app.flextell.ai/api biçimindedir ve tüm yollar /v1/... ile başlar. Aynı adresi /api/v1 önekiyle birleştirmeyin, yoksa önek iki kez yazılır.
OpenAPI belgesindeki güvenlik şeması, yetkilendirme ve token adreslerini API adresinin altında gösterir ve tek bir * scope’u tanımlar. Bu bilgileri kullanmayın. Adresler için yukarıdaki Kimlik sunucusu bölümüne, scope listesi için Scope’lar sayfasına bakın. Belgenin info.version değeri (0.0.1) sürümlerle birlikte değişmez; API sürümü için yol önekine güvenin.

Sonraki adımlar

Hızlı başlangıç

Uygulama oluşturun, token alın ve ilk isteği gönderin.

Kimlik doğrulama

OAuth 2.0 akışını ve token türlerini öğrenin.