eKooliga sisselogimine võimaldab kasutajal siseneda teise ettevõtte teenusesse oma eKooli kontoga. Nii saab näiteks sisse logida e-Koolikotti ja Opiqusse. Sisselogimine põhineb OAuth 2.0 standardil.
Kuidas taotleda OAuth 2.0 klienti
Kirjuta aadressile [email protected] või võta meiega ühendust Teadmusbaasi vestlusakna kaudu. Lisa kirja:
ettevõtte või asutuse nimi
kontaktisiku nimi, e-posti aadress ja telefoninumber
teenuse nimi ja lühikirjeldus
miks soovid, et kasutaja saaks sinu teenusesse eKooli kontoga sisse logida
ümbersuunamise aadress (
redirect_uri), näitekshttps://sinu-teenus.ee/oauth/callback
Ilma kooli nõusolekuta saab teenus ainult sisse logiva kasutaja põhiandmed. Kui teenus vajab õppeinfot, loe allpool, kuidas kool saab lubada seda jagada.
Kui taotlus on kinnitatud, saab teenus kliendi tunnuse (client_id) ja lubatud õigused. Kuidas teenus kasutaja eKooli kaudu sisse logib ja autendib, loe API dokumentatsioonist.
Mida OAuth 2.0 klient võimaldab
Kui kasutaja annab sisselogimisel nõusoleku, saab teenus tema eKooli konto põhiandmed, rollid ja koolid.
Õppeinfole klient automaatselt ligipääsu ei anna. Näiteks kodutöid, hindeid ja päevikuid teenus ainult sisselogimise kaudu ei näe.
OAuth 2.0 klient annab ligipääsu ka eKooli avalikule API-le. Avalikus API-s on piiratud hulk meetodeid ja need on kirjeldatud lehel api-docs-public.ekool.eu. Teisi meetodeid lisame vastavalt koolide vajadustele.
Õppeinfo eest vastutab kool ja eKool töötleb neid andmeid kooli nimel. Seepärast peab õppeinfo jagamise lubama kool ja kasutaja sisselogimisest üksi ei piisa.
Kui teenus vajab andmeid, mida avalik API ei paku, saab kool lisada integratsiooni soovi eKooli Mõttekojas.