ReadHaven Public API
Unity Developer Rehberi
ReadHaven oyun istemcisinin (Unity) kullandığı public API'yi bu rehberden öğrenip test edebilirsin. Her endpoint'in ne iş yaptığı, hangi alanları döndürdüğü ve kimlik doğrulama akışı burada açıkça anlatılır. Endpointleri tarayıcıdan doğrudan çalıştırabilirsin.
Bu rehberde ne var?
Hızlı Başlangıç
İlk çağrını 3 adımda at: giriş yap, token al, korumalı bir endpoint çağır.
Kimlik Doğrulama
Login akışı, JWT token, Authorization: Bearer kullanımı ve token süresi.
Cevaplar & Hatalar
Tüm cevapların sarıldığı ApiResponse zarfı ve hata kodları.
İnteraktif Referans
Her endpoint'i tarayıcıdan çalıştır, gerçek istek/cevabı gör.
Temel prensipler
- Tüm yollar
/api/...önekiyle başlar. - Her cevap aynı zarfla gelir:
ApiResponse<T>—isSuccess,statusCode,message,data. - Giriş (
login) vehealthhariç tüm endpointler bearer token ister. - İş hataları da HTTP 200 ile döner; gerçek sonucu
isSuccess/statusCode'dan oku (detay).
Public endpointler
Unity istemcisinin kullandığı tüm endpointler (backoffice hariç):
| Alan | Endpoint | Ne yapar | Erişim |
|---|---|---|---|
| Auth | POST /api/auth/login | Kullanıcı girişi, token döndürür | Anonim |
| Me | GET /api/me/profile | Giriş yapan kullanıcının profili | Bearer |
| Paragraphs | GET /api/paragraphs | Paragraf listesi | Bearer |
| Paragraphs | GET /api/paragraphs/{id} | Paragraf detayı (soru/kelime) | Bearer |
| Paragraphs | POST /api/paragraphs/{id}/complete | Paragrafı tamamla, sonuç döndürür | Bearer |
| Assignments | GET /api/assignments | Ödev listesi | Bearer |
| Assignments | GET /api/assignments/{id} | Ödev detayı | Bearer |
| Assignments | POST /api/assignments/paragraphs/{id}/finish | Ödev paragrafını bitir | Bearer |
| GameSessions | GET /api/game-sessions/daily | Günlük oyun oturumu | Bearer |
| GameSessions | GET /api/game-sessions/items/{id} | Oturum ögesi detayı | Bearer |
| GameSessions | POST /api/game-sessions/items/{id}/finish | Oturum ögesini bitir | Bearer |
| Health | GET /api/health | Servis ayakta mı kontrolü | Anonim |
Her alanın tam şeması nerede?
Request/response alanlarının tam listesi ve tipleri, canlı olarak
İnteraktif API Referansı'nda (OpenAPI) yer alır.
Bu rehber sayfaları akışı ve kavramları anlatır; referans ise alan alan şemadır.