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?

Temel prensipler

  • Tüm yollar /api/... önekiyle başlar.
  • Her cevap aynı zarfla gelir: ApiResponse<T> — isSuccess, statusCode, message, data.
  • Giriş (login) ve health hariç 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ç):

AlanEndpointNe yaparErişim
AuthPOST /api/auth/loginKullanıcı girişi, token döndürürAnonim
AuthPOST /api/auth/registerBireysel öğrenci kaydı başlatAnonim
AuthPOST /api/auth/register/confirmKaydı OTP ile tamamlaAnonim
AuthPOST /api/auth/password-reset/requestŞifre sıfırlama kodu isteAnonim
AuthPOST /api/auth/password-reset/confirmŞifre sıfırlamayı onaylaAnonim
AuthPOST /api/auth/email-verification/requestE-posta doğrulama kodu isteAnonim
AuthPOST /api/auth/email-verification/confirmE-posta doğrulamayı onaylaAnonim
AuthDELETE /api/auth/accountHesabı pasifleştirBearer
MeGET /api/me/profileGiriş yapan kullanıcının profiliBearer
MePUT /api/me/push-installations/{deviceInstallationId}Push kaydı oluştur/yenile (FID)Bearer
MeDELETE /api/me/push-installations/{deviceInstallationId}Push kaydını kaldır (çıkış)Bearer
ParagraphsGET /api/paragraphsParagraf listesiBearer
ParagraphsGET /api/paragraphs/{id}Paragraf detayı (soru/kelime)Bearer
ParagraphsPOST /api/paragraphs/{id}/completeParagrafı tamamla, sonuç döndürürBearer
AssignmentsGET /api/assignmentsÖdev listesiBearer
AssignmentsGET /api/assignments/{id}Ödev detayıBearer
AssignmentsPOST /api/assignments/paragraphs/{id}/finishÖdev paragrafını bitirBearer
GameSessionsGET /api/game-sessions/dailyGünlük oyun oturumuBearer
GameSessionsGET /api/game-sessions/items/{id}Oturum ögesi detayıBearer
GameSessionsPOST /api/game-sessions/items/{id}/finishOturum ögesini bitirBearer
HealthGET /api/healthServis ayakta mı kontrolüAnonim
HealthPOST /api/health/app-versioniOS/Android sürüm kontrolü (min/max)Anonim
GamificationGET /api/gamification/meWallet, envanter, avatar, loot box durumuBearer
GamificationGET /api/gamification/rewards/pendingClaim bekleyen ödüllerBearer
GamificationPOST /api/gamification/rewards/{id}/claimÖdülü claim etBearer
GamificationGET /api/gamification/streaks/meStreak durumuBearer
GamificationGET /api/gamification/missions/meGünün görevleri (missions)Bearer
GamificationGET /api/gamification/achievements/meAchievement katalog + unlock durumuBearer
GamificationPOST /api/gamification/achievements/{id}/seenAchievement'ı görüldü işaretleBearer
GamificationGET /api/gamification/classroomSınıf avatar görünümüBearer
GamificationGET /api/gamification/classroom/feedSınıf feed'i (achievement vb.)Bearer
GamificationGET /api/gamification/classroom/leaderboardSınıf XP sıralaması (AllTime/Weekly/Monthly)Bearer
GamificationGET /api/gamification/sub-corporation/leaderboardAlt kurum + aynı sınıf seviyesi XP sıralamasıBearer
GamificationGET /api/gamification/store/catalogMağaza kataloguBearer
GamificationPOST /api/gamification/store/items/{itemCode}/purchaseMağazadan item satın alBearer
GamificationPOST /api/gamification/items/{id}/equipAvatar itemı takBearer
GamificationPOST /api/gamification/items/{id}/unequipAvatar itemı çıkarBearer
GamificationPOST /api/gamification/items/{id}/sellEnvanter itemını satBearer
GamificationPOST /api/gamification/loot-boxes/{id}/openLoot box açBearer
WordLearningPOST /api/word-learning/sessions/startKelime öğrenme oturumu başlatBearer
WordLearningGET /api/word-learning/sessions/currentAktif kelime öğrenme oturumuBearer
WordLearningPOST /api/word-learning/sessions/{id}/finishOturumu bitir (sonuç + SRS)Bearer
MiniGamesGET /api/mini-gamesMini oyun listesi + durumBearer
MiniGamesPOST /api/mini-games/{miniGameCode}/completeMini oyun tamamlaBearer
EventsGET /api/eventsEtkinlik listesi + sıra, hak, ödül durumuBearer
EventsPOST /api/events/{eventIdentifier}/runsKoşu başlat, ilk soruBearer
EventsPOST /api/events/{eventIdentifier}/runs/{runIdentifier}/nextSıradaki soruBearer
EventsPOST /api/events/{eventIdentifier}/runs/{runIdentifier}/answersCevap gönder (sunucu puanlar)Bearer
EventsPOST /api/events/{eventIdentifier}/runs/{runIdentifier}/finishKoşuyu bitir, sonuç + sıraBearer
EventsGET /api/events/{eventIdentifier}/leaderboardEtkinlik sıralamasıBearer
FeedbackGET /api/feedback/topicsGeri bildirim konularıBearer
FeedbackPOST /api/feedbackGeri 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.