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
MeGET /api/me/profileGiriş yapan kullanıcının profiliBearer
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
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.