API Dokümantasyonu — Genel Bakış
Bu bölüm, IQV Platform ön yüzünün (frontend) gerçekten çağırdığı backend uç noktalarını, kaynak koddan doğrulanmış şekilde belgeler (dashboard/src/routes/api.tsx, dashboard/src/services/*.tsx, dashboard/src/utils/http.tsx, dashboard/src/utils/index.tsx). Uydurma veya varsayımsal bir uç nokta içermez.
Temel adres (Base URL)
| Ortam | Temel adres | Kaynak |
|---|---|---|
| Üretim (production) | https://platform.iqvizyon.com (veya VITE_PLATFORM_API_BASE_URL ile geçersiz kılınabilir) |
PLATFORM_API_BASE_URL, dashboard/src/utils/index.tsx |
| Geliştirme (development) | /iqv-platform-api (Vite yerel geliştirme sunucusu proxy'si, aynı backend'e CORS'suz yönlendirir) |
API_BASE_URL, dashboard/src/utils/index.tsx + dashboard/vite.config.ts |
Ayrıca not eklerinin dosyaları için ayrı, herkese açık bir MinIO nesne deposu adresi kullanılır: https://minio.iqvizyon.com (MINIO_PUBLIC_BASE_URL) — bu adres API origin'inden bağımsızdır.
Ortam değişkenleri
| Değişken | Amacı |
|---|---|
VITE_PLATFORM_API_BASE_URL |
Gerçek IQV Platform backend'inin temel adresi (üretimde kullanılır) |
VITE_DEMO_MODE |
true/false — gerçek backend yerine eski/demo ReqRes giriş akışını etkinleştirir |
VITE_REQRES_API_KEY |
Yalnızca demo ReqRes giriş akışı için API anahtarı |
Gizli değerlerin gerçek içeriği bu dokümantasyonda yer almaz; yalnızca değişken adları ve amaçları belgelenmiştir.
Uç nokta grupları
| Grup | Sayfa |
|---|---|
| Kimlik doğrulama | Kimlik Doğrulama |
| Platform modülleri ve sıralama | Platform Modülleri |
| Notlar ve hatırlatıcılar | Notlar ve Hatırlatıcılar |
| E-posta ile paylaşım | Mail Box |
| Kullanıcı listesi ve denetim günlüğü | Kullanıcılar ve Denetim Günlüğü |
Kimlik doğrulama yöntemi
Her istekte (yalnızca /login hariç) merkezi Axios istemcisinin (dashboard/src/utils/http.tsx) istek arayüzcüsü tarafından otomatik olarak eklenen bir JWT bearer token kullanılır: Authorization: Bearer <token>.
Token şu sırayla aranır: (1) Redux state (admin.token), (2) localStorage.token, (3) localStorage.auth_tokens (eski sürümle uyumluluk için ayrıştırılan JSON). 401/403 yanıtı (login isteği hariç) otomatik çıkışı tetikler — ayrıntı için bkz. Kimlik Doğrulama.
Eski/demo API (kapsam dışı)
dashboard/src/routes/api.tsx içindeki apiRoutes nesnesi, yalnızca VITE_DEMO_MODE=true iken kullanılan, https://reqres.in/api adresine giden eski/demo bir giriş akışını tanımlar (login, logout, users, reviews). Bu, gerçek IQV Platform verisiyle ilgisi olmayan, başlangıç şablonundan kalan bir demo entegrasyondur ve bu dokümantasyonun kapsamı dışındadır.