Skip to main content
Kullanım amacı: API endpoint’lerine istek atabilmek için gerekli olan Access Token’ı Authorization Code akışıyla altyapıdan talep edebilmek.
API’lerimize erişim sağlayabilmek için öncelikle sistemde bir OAuth Client (Uygulama) tanımlamanız ve doğru yetki kapsamlarını (scopes) belirlemeniz gerekmektedir.

1. Uygulama (Client) oluşturma adımları

Access Token alabilmek için gerekli istemciyi oluşturmak adına App Panelindeki Wizard (Sihirbaz) adımlarını izleyin:
1

Panele giriş

Sisteme kendi kullanıcı hesabınızla giriş yapın.
2

Menüye gidin

Sol menüden Bağlantılar → Uygulamalar sayfasına gidin.
3

Yeni kayıt

Sağ üstteki “Uygulama Oluştur” butonuna tıklayarak sihirbazı başlatın.

Adım 1: Uygulama bilgileri

Uygulama Adı
string
required
Entegrasyonu yapacak uygulamanın adı (örn. Postman, Mobil Uygulama, Partner Entegrasyonu).
Yönlendirme URI'leri (Redirect URIs)
array
required
En az 1 adet girmek zorunludur. Sistemin yetki onayından sonra döneceği adrestir.
  • Postman için: Postman’in OAuth callback URL’si
  • Kendi uygulamanız için: Uygulamanızın OAuth onayını yakalayacağı endpoint
Bu aşamada yetki kapsamları (scopes) ekranda görünmez. İzinleri bir sonraki adımda düzenleme modunda seçeceğiz. Kaydet diyerek ilerleyin.

Adım 2: Kimlik bilgileri (çok önemli)

Kaydetme işleminden sonra karşınıza kimlik bilgilerini gösteren bir ekran çıkacaktır:
AlanAçıklama
Client IDUygulamanızın benzersiz kimliği.
Client SecretUygulamanızın gizli anahtarı.
Client Secret değeri güvenlik gereği sadece bu ekranda bir kez gösterilir. Lütfen bu değeri güvenli bir yere (Postman Environment vb.) kopyalayıp saklayın.

Adım 3: İzinler / yetki kapsamları (scopes)

Yönlendirme URI’leri alanının hemen altında bulunan listeden, uygulamanın ihtiyaç duyduğu yetkileri (örn. customers:read, appointments:write) işaretleyin ve Kaydet diyerek ilerleyin.
Önemli: Sistem mimarisi gereği yetki kapsamları (scopes) sadece yeni uygulama oluşturulurken (Wizard ekranında) seçilebilir.Uygulamayı kaydettikten sonra “Düzenle” (Edit) ekranına girdiğinizde scope’ları değiştiremezsiniz. Eğer mevcut bir uygulamanın yetkilerini güncellemeniz gerekirse, o uygulamayı silip yeni bir uygulama (client) oluşturmanız gerekmektedir.

2. Postman ile token alma (Authorization Code akışı)

Elde ettiğiniz kimlik bilgileriyle Postman üzerinden ilk token’ınızı almak için ilgili isteğin Authorization sekmesini aşağıdaki gibi doldurun:
AlanDeğer
TypeOAuth 2.0
Grant TypeAuthorization Code
Callback URLPanelde girdiğinizin aynısı
Auth URL{{base_url}}/oauth/authorize
Access Token URL{{base_url}}/oauth/token
Client IDPanelden aldığınız Client ID
Client SecretPanelden kopyaladığınız Client Secret
ScopePanelde seçtiğiniz scope’ları aralarında boşluk bırakarak yazın (örn. customers:read appointments:write).
Client AuthenticationSend as Basic Auth header
Tüm bunları doldurduktan sonra “Get New Access Token” butonuna tıklayın. Karşınıza sistemin giriş ekranı çıkacak; giriş yapıp izin verdikten sonra Postman otomatik olarak Access Token’ınızı alacaktır.

3. Token sonrası ilk adımlar ve tenant seçimi

Token’ı aldıktan sonra, sistemin geri kalanını kullanabilmek için bağlamı (tenant’ı) belirlemeniz gerekir. İdeal başlangıç akışı şöyledir:
1

Profilinizi ve tenant'larınızı görün

GET /api/v1/account veya GET /api/v1/account/tenants isteklerini atarak hesabınıza bağlı kliniklerin (tenant) listesini ve ID’lerini öğrenin.
2

Tenant ID'yi sabitleyin

Çalışmak istediğiniz tenant’ın ID’sini (örn. 5) Postman değişkenlerinize ekleyin.
3

İsteklere başlayın

Bundan sonraki tüm tenant-bağımlı API isteklerinizde (Randevular, Hastalar, Dosyalar vb.) header kısmına X-Tenant: 5 bilgisini eklemeyi unutmayın.
/account ve /account/tenants dışındaki tüm tenant-bağımlı endpoint’ler için X-Tenant header’ı zorunludur.