Ortamlar
API adresi
Tüm kaynak uç noktaları API adresinin altındadır. Bu dokümandaki örnekler canlı adresi kullanır.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.
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.
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.
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.