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 |
| Auth | POST /api/auth/register | Bireysel öğrenci kaydı başlat | Anonim |
| Auth | POST /api/auth/register/confirm | Kaydı OTP ile tamamla | Anonim |
| Auth | POST /api/auth/password-reset/request | Şifre sıfırlama kodu iste | Anonim |
| Auth | POST /api/auth/password-reset/confirm | Şifre sıfırlamayı onayla | Anonim |
| Auth | POST /api/auth/email-verification/request | E-posta doğrulama kodu iste | Anonim |
| Auth | POST /api/auth/email-verification/confirm | E-posta doğrulamayı onayla | Anonim |
| Auth | DELETE /api/auth/account | Hesabı pasifleştir | Bearer |
| Me | GET /api/me/profile | Giriş yapan kullanıcının profili | Bearer |
| Me | PUT /api/me/push-installations/{deviceInstallationId} | Push kaydı oluştur/yenile (FID) | Bearer |
| Me | DELETE /api/me/push-installations/{deviceInstallationId} | Push kaydını kaldır (çıkış) | 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 |
| Health | POST /api/health/app-version | iOS/Android sürüm kontrolü (min/max) | Anonim |
| Gamification | GET /api/gamification/me | Wallet, envanter, avatar, loot box durumu | Bearer |
| Gamification | GET /api/gamification/rewards/pending | Claim bekleyen ödüller | Bearer |
| Gamification | POST /api/gamification/rewards/{id}/claim | Ödülü claim et | Bearer |
| Gamification | GET /api/gamification/streaks/me | Streak durumu | Bearer |
| Gamification | GET /api/gamification/missions/me | Günün görevleri (missions) | Bearer |
| Gamification | GET /api/gamification/achievements/me | Achievement katalog + unlock durumu | Bearer |
| Gamification | POST /api/gamification/achievements/{id}/seen | Achievement'ı görüldü işaretle | Bearer |
| Gamification | GET /api/gamification/classroom | Sınıf avatar görünümü | Bearer |
| Gamification | GET /api/gamification/classroom/feed | Sınıf feed'i (achievement vb.) | Bearer |
| Gamification | GET /api/gamification/classroom/leaderboard | Sınıf XP sıralaması (AllTime/Weekly/Monthly) | Bearer |
| Gamification | GET /api/gamification/sub-corporation/leaderboard | Alt kurum + aynı sınıf seviyesi XP sıralaması | Bearer |
| Gamification | GET /api/gamification/store/catalog | Mağaza katalogu | Bearer |
| Gamification | POST /api/gamification/store/items/{itemCode}/purchase | Mağazadan item satın al | Bearer |
| Gamification | POST /api/gamification/items/{id}/equip | Avatar itemı tak | Bearer |
| Gamification | POST /api/gamification/items/{id}/unequip | Avatar itemı çıkar | Bearer |
| Gamification | POST /api/gamification/items/{id}/sell | Envanter itemını sat | Bearer |
| Gamification | POST /api/gamification/loot-boxes/{id}/open | Loot box aç | Bearer |
| WordLearning | POST /api/word-learning/sessions/start | Kelime öğrenme oturumu başlat | Bearer |
| WordLearning | GET /api/word-learning/sessions/current | Aktif kelime öğrenme oturumu | Bearer |
| WordLearning | POST /api/word-learning/sessions/{id}/finish | Oturumu bitir (sonuç + SRS) | Bearer |
| MiniGames | GET /api/mini-games | Mini oyun listesi + durum | Bearer |
| MiniGames | POST /api/mini-games/{miniGameCode}/complete | Mini oyun tamamla | Bearer |
| Events | GET /api/events | Etkinlik listesi + sıra, hak, ödül durumu | Bearer |
| Events | POST /api/events/{eventIdentifier}/runs | Koşu başlat, ilk soru | Bearer |
| Events | POST /api/events/{eventIdentifier}/runs/{runIdentifier}/next | Sıradaki soru | Bearer |
| Events | POST /api/events/{eventIdentifier}/runs/{runIdentifier}/answers | Cevap gönder (sunucu puanlar) | Bearer |
| Events | POST /api/events/{eventIdentifier}/runs/{runIdentifier}/finish | Koşuyu bitir, sonuç + sıra | Bearer |
| Events | GET /api/events/{eventIdentifier}/leaderboard | Etkinlik sıralaması | Bearer |
| Feedback | GET /api/feedback/topics | Geri bildirim konuları | Bearer |
| Feedback | POST /api/feedback | Geri bildirim gönder (form + dosya) | Bearer |
Test araçları (TestOps)
Yukarıdaki ürün endpointlerine ek olarak, Unity testleri için veri manipülasyonu
sağlayan test-only bir yüzey vardır (
/api/test-ops):
wallet/XP ayarla, günlük oturumu zorla, mini oyun seviyesi, feed vb. Bearer değil,
X-TestOps-Key ile çalışır. Detay: TestOps.
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.