eKooli API kasutamiseks on vaja OAuth 2.0 kliendi juurdepääsuandmeid. Uue kliendi loomiseks tuleb saata ligipääsutaotlus aadressile [email protected].
Taotlusesse lisatav info
asutuse või ettevõtte nimi
vastutava isiku ees- ja perekonnanimi, e-posti aadress ja telefoninumber
autoriseeringu kasutamise eesmärk
redirect URL, näiteks https://my.application.com/oauth2/callback
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_idkoosneb 32 numbrist ja sümbolist, näiteksoaD43fvd3aCdf45dDsc428hMuY6T6trGclient_secretkoosneb 40 numbrist ja sümbolist, näiteks8yFFEvVq65ukVTWtDVRMjttM5nyRg0ErCBJnRSlbscopeskoosnevad sõnadest või sõnade kombinatsioonidest, mis tähistavad andmetele juurdepääsuõigusi, näiteksusers-basic
Hoida client_id, client_secret ja scopes turvalises kohas.
Täpsem info on avalikus dokumentatsioonis: eKool API.
