Mine põhisisu juurde

Kuidas taotleda eKooli API ligipääsu

Juhend OAuth 2.0 kliendi juurdepääsuandmete taotlemiseks ja eKooli API dokumentatsiooni avamiseks.

eKooli API kasutamiseks on vaja OAuth 2.0 kliendi juurdepääsuandmeid. Uue kliendi loomiseks tuleb saata ligipääsutaotlus aadressile [email protected].

Taotlusesse lisatav info

Pärast juurdepääsuandmete saamist

Vastuskirjas saadetakse kliendirakenduse identifikaator (client_id), sellega seotud parool (client_secret) ja kasutatavad ulatused (scopes). Nende andmetega saab teha päringuid eKooli autoriseerimisserveri aadressil {{login_url}}/oauth/.

  • client_id koosneb 32 numbrist ja sümbolist, näiteks oaD43fvd3aCdf45dDsc428hMuY6T6trG

  • client_secret koosneb 40 numbrist ja sümbolist, näiteks 8yFFEvVq65ukVTWtDVRMjttM5nyRg0ErCBJnRSlb

  • scopes koosnevad sõnadest või sõnade kombinatsioonidest, mis tähistavad andmetele juurdepääsuõigusi, näiteks users-basic

Hoida client_id, client_secret ja scopes turvalises kohas.

Täpsem info on avalikus dokumentatsioonis: eKool API.

Kas see vastas teie küsimusele?