access_token edinir, klinik seçer ve Hastalar listesini çekersiniz. Her adımın ayrıntısı için ilgili kimlik doğrulama sayfasına bağlantı verilir.
Örneklerde üretim adresleri kullanılır. Test ortamı adresleri için Ortamlar sayfasına bakın.
Ön koşullar
- Bir Flextell kullanıcı hesabı ve en az bir kliniğe üyelik.
- Kullanıcının, uygulamayı oluşturacağı klinikte
Create:Clientizni. Panelde Bağlantılar → Uygulamalar sayfasını görmek içinView:Clientizni gerekir. client_secretdeğerini güvenle saklayabileceğiniz bir sunucu. Flextell’de oluşturulan uygulamalar her zaman gizli (confidential) istemcidir; yetkilendirme kodunu token ile sunucunuzda değiştirmeniz gerekir.curlveopensslkomutları (örnekler kabuk komutudur).
Bir uygulama, onu oluşturan kullanıcıya aittir. Klinikteki diğer kullanıcılar uygulamayı listede görmez ve yönetemez. Uygulamayı yetkilendiren her kullanıcı, kendi üyesi olduğu kliniklerde, uygulamanın scope’ları ve kendi izinleri ölçüsünde işlem yapabilir.
Uygulama oluşturma
Uygulama, API’ye erişecek yazılımınızın Flextell’deki kaydıdır. Oluşturma sonunda birClient ID ve bir Client Secret alırsınız.
1
Sihirbazı açın
Bağlantılar → Uygulamalar sayfasında Uygulama Oluştur’a tıklayın.
2
Uygulama bilgilerini girin
Uygulama Bilgileri adımında Uygulama Adı ve en az bir Yönlendirme URI’leri değeri girin (en fazla 20 adres). İsterseniz Çıkış Sonrası Yönlendirme URI’leri de ekleyin. İleri’ye tıklayın.
3
İzinleri seçin
İzinler adımında uygulamanızın isteyebileceği scope’ları seçin. Bu rehberdeki örnekler için
account:read ve customers:read yeterlidir. account:read, sonraki bölümde klinik listesini almak için gereklidir. İleri’ye tıklayın.4
Kimlik bilgilerini kaydedin
Kimlik Bilgileri adımında
Client ID ve Client Secret değerlerini kopyalayın, ardından Bitir’e tıklayın.myapp:// gibi özel şemalar kabul edilmez.
Uygulamayı API ile de oluşturabilirsiniz. Bu istek, oauth_clients:write scope’u taşıyan bir token ve X-Tenant başlığı gerektirir:
201 ile döner ve data.secret alanında secret’ı içerir. Ayrıntılar için Uygulama oluşturma ve OAuth uygulamaları sayfalarına bakın.
Kullanıcıyı yetkilendirme
Flextell, yetkilendirme kodu akışını PKCE ile destekler. Önce rastgele bircode_verifier ve ondan türeyen code_challenge üretin:
code_verifier, 43–128 karakterlik ve yalnızca A-Z a-z 0-9 - . _ ~ karakterlerinden oluşan bir metin olmalıdır. code_challenge_method değerini her zaman S256 gönderin; göndermezseniz sunucu plain varsayar.
Kullanıcının tarayıcısını şu adrese yönlendirin:
Kullanıcı oturum açar (Giriş Yap), iki adımlı doğrulaması varsa kodunu girer ve onay ekranında Erişim İzni Ver’e tıklar. Sonra tarayıcı şu adrese döner:
error=access_denied eklenir. state değerini kontrol edin, ardından kodu hemen kullanın: kod 10 dakika geçerlidir ve yalnızca bir kez çalışır. Akışın tamamı için Yetkilendirme kodu ve PKCE sayfasına bakın.
Token alma
Kodu sunucunuzdan token ile değiştirin:client_id ve client_secret alanları yerine HTTP Basic kimlik doğrulaması da kullanabilirsiniz (-u "<client_id>:<client_secret>"). Accept: application/json başlığını gönderin; hatalar JSON döner.
access_token 5 dakika geçerlidir (expires_in: 300). refresh_token 7 gün geçerlidir ve her kullanımda yenilenir. Yenileme isteği yeni bir access_token ile yeni bir refresh_token döndürür; eski refresh_token geçersiz olur, bu yüzden yenisini hemen saklayın.scope yalnızca daraltılabilir; yeni bir scope için kullanıcıyı yeniden yetkilendirmeniz gerekir. Ayrıntılar: Token’lar ve Scope’lar.
Klinik seçme
Flextell’de bir kullanıcı birden fazla kliniğe üye olabilir. Klinik verisi kullanan her istekte, hangi klinikte çalıştığınızıX-Tenant başlığıyla bildirirsiniz. Başlığın değeri kliniğin sayısal id değeridir (slug değil). Kullanıcının kliniklerini account:read scope’u ile listeleyin; bu istekte X-Tenant gerekmez:
id değerini alın. Klinik değiştirmek için yeni token almanız gerekmez; aynı token kullanıcının tüm kliniklerinde geçerlidir, yalnızca X-Tenant değerini değiştirirsiniz. Ayrıntılar: Klinikler ve X-Tenant.
İlk istek
Seçtiğiniz klinikte hastaları listeleyin:customers:read scope’u ve kullanıcının seçili klinikte View:Customer izni. Liste sayfalıdır; yanıt data, links ve meta alanlarını içerir. Hangi kayıtları göreceğiniz kullanıcının izinlerine bağlıdır; bkz. İzinler ve görünürlük. Sayfalama için Sayfalama, alan ayrıntıları için Hastalar sayfasına bakın.
200 yanıtı ve data içinde hasta kayıtları aldıysanız kurulum tamamdır.Sık karşılaşılan hatalar
Tüm hata kodları için Hata kodları ve Kimlik doğrulama hataları sayfalarına bakın.
Sonraki adımlar
Kimlik doğrulama
Akışın tamamı, token ömürleri ve çıkış.
Başlıklar
Her istekte kullanacağınız başlıklar.
Sayfalama
Liste yanıtlarında sayfa gezme.
Oran sınırları
İstek sınırları ve 429 yanıtı.