Sahte Allstar API

Gerçek Allstar entegrasyonu gelene kadar Kütüphanem geliştirmesi için. Veriler uydurmadır ve sabittir: aynı istek hep aynı yanıtı verir.

Taban adres: https://api.ucdortbesallstarbi.com. Her /v1 isteğinde Authorization: Bearer <anahtar> gerekir. Yanıt: { data, meta? }, hata: { error: { code, message } }.

Hata denemek için: X-Fake-Fail: 401|429|500|503, gecikme için X-Fake-Delay: 1500 (ms, en çok 10000).

Örnek kimlikler: okul sch_1001, sınıf cls_8c, öğrenci stu_8c_01, öğretmen tch_001, kitap bk_mat8_dk, soru Q-MAT8-DK-00001. Makine okur liste: /v1.

İstekNe yaparGörev
POST /v1/auth/qr/sessionsTest için bir QR yükü üretir (Allstar uygulamasının ekranda göstereceği kod)15
POST /v1/auth/qr/exchangeOkunan QR yükünü okul erişim koduna ve öğretmene çevirir. Gövde: { payload }15
GET /v1/schools/:idOkul bilgisi15
GET /v1/schools/:id/classesOkulun sınıfları23, 25
GET /v1/schools/:id/teachersOkulun öğretmenleri ve branşları17, 25
GET /v1/teachers/:idÖğretmen, branşı ve sınıfları17, 25
GET /v1/teachers/:id/scheduleÖğretmenin haftalık ders programı17
GET /v1/classes/:id/studentsSınıfın öğrencileri27, 30
GET /v1/classes/:id/statsSınıfın çözülen/doğru/yanlış/boş sayıları. ?lessonId= ?bookId= ?perStudent=130
GET /v1/students/:id/statsÖğrencinin çözülen/doğru/yanlış/boş sayıları. ?lessonId= ?bookId=30
GET /v1/lessonsDersler32
GET /v1/topicsKonular. ?lessonId= ?grade=26, 32
GET /v1/sectionsBölüm türleri (orta anlatım, derece anlatım ...)32
GET /v1/booksKitaplar, tür ve eş kitap kimliğiyle. ?grade= ?lessonId= ?kind=16, 32
GET /v1/books/:idTek kitap16
GET /v1/books/:id/questionsKitabın soru kimlikleri. ?page= ?topicId= ?section= ?limit= ?offset=32
GET /v1/books/:id/pacingMüfredat planı: haftaya göre beklenen sayfa aralığı23
GET /v1/questions/:idTek soru ve ikizi21, 32
GET /v1/questions/:id/statsSorunun bir sınıftaki sonucu. ?classId= (zorunlu)30
GET /v1/students/:id/zero-errorÖğrencinin sıfır hata listesi. ?lessonId= ?bookId= ?status= ?limit= ?offset=29
GET /v1/classes/:id/zero-errorSınıfın sıfır hata özeti, öğrenci başına. ?lessonId= ?bookId=29
GET /v1/classes/:id/twin-errorsİkiz hatalar: hem soruyu hem ikizini yanlış yapan öğrenciler, soru başına. ?lessonId= ?bookId= ?limit= ?offset=21
POST /v1/classes/:id/progressKütüphanem'den Allstar'a: sınıfın kaldığı sayfa. Gövde: { bookId, page, lessonId?, at? }23, 25
GET /v1/classes/:id/progressSınıfın kitap başına kaldığı sayfa ve plana göre farkı. ?week= (1-36)23, 25