Kullanım amacı: API endpoint’lerine istek atabilmek için gerekli olan Access Token’ı Authorization Code akışıyla altyapıdan talep edebilmek.
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:Adım 1: Uygulama bilgileri
Entegrasyonu yapacak uygulamanın adı (örn. Postman, Mobil Uygulama, Partner Entegrasyonu).
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:| Alan | Açıklama |
|---|---|
Client ID | Uygulamanızın benzersiz kimliği. |
Client Secret | Uygulamanızın gizli anahtarı. |
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.
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:| Alan | Değer |
|---|---|
| Type | OAuth 2.0 |
| Grant Type | Authorization Code |
| Callback URL | Panelde girdiğinizin aynısı |
| Auth URL | {{base_url}}/oauth/authorize |
| Access Token URL | {{base_url}}/oauth/token |
| Client ID | Panelden aldığınız Client ID |
| Client Secret | Panelden kopyaladığınız Client Secret |
| Scope | Panelde seçtiğiniz scope’ları aralarında boşluk bırakarak yazın (örn. customers:read appointments:write). |
| Client Authentication | Send as Basic Auth header |
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: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.Tenant ID'yi sabitleyin
Çalışmak istediğiniz tenant’ın ID’sini (örn.
5) Postman değişkenlerinize ekleyin./account ve /account/tenants dışındaki tüm tenant-bağımlı endpoint’ler için X-Tenant header’ı zorunludur.