Main » Historie » Verze 8
« Předchozí -
Verze 8/24
(rozdíl) -
Další » -
Aktuální verze
Jakub Jirůtka, 2011-10-23 16:44
Hlavní stránka¶
O projektu¶
KOSapi poskytuje aplikační rozhraní v podobě RESTful webových služeb, které zprostředkovává přístup k vybrané části dat z KOSu. Umožňuje a podporuje vznik školních i studentských aplikací, které pro svou činnost vyžadují online aplikační přístup k datům souvisejícím s výukou. Odstraňuje nutnost zpracovávání exportů, neustálou duplikaci všech dat a potíže s jejich udržováním. Staví na osvědčených konceptech webu jakožto distribuovaného prostředí vzájemně provázaných informací.
Zdrojem dat pro KOSapi jsou momentálně databázové exporty z KOSu. V případě aktuální verze KOSapi-3 se jedná o dočasné řešení, neboť ta už je připravená pro přímé napojení na databázi KOS. Máme připravené příslušné databázové pohledy a momentálně dovršují jednání s VIC o poskytnutí přístupu. Poté bude KOSapi-3 poskytovat read-only přístup ke všem datům týkající se Bílé knihy a rozvrhů, která jsou dostupná celé akademické obci. Získání práva zápisu do KOSu je při současném přístupu VIC bohužel nereálné, nicméně do budoucna to plánujeme.
Aktuálně jsou dostupné instance pro FEL a FIT, prakticky není problém spustit instance i pro další fakulty ČVUT. Provoz KOSapi technicky zajišťuje SVTI FEL, resp. IT oddělení FIT.
Co tu najdete?¶
Na těchto stránkách najdete dokumentaci KOSapi-3, bug tracking a přehled novinek. Chcete-li zadat zadat požadavek nebo reportovat chybu, přihlaste se prosím svým loginem do KOSu - ověřování probíhá proti LDAP serveru Usermap. Heslo se přenáší přes šifrovaný kanál, nikdo k němu nemá přístup ani se neloguje. Pokud k tomu přesto nemáte důvěru, napište mi prosím na kosapi@feld.cvut.cz o založení lokálního účtu.
Dokumentaci předchozích verzí 1 a 2, které jsou stále v provozu, naleznete na https://kosapi.fit.cvut.cz/old. Tyto verze už se nebudou dále vyvíjet.
Jak začít?¶
- Nejprve si pročtěte dokumentaci na této wiki. Pokud zde na některou otázku nenajdete odpověď, napište mi prosím dotaz na podporu (předtím je nutné se přihlásit), příp. e-mail na kosapi@fel.cvut.cz.
- Na stránce RESTful zdroje najdete adresy jednotlivých zdrojů webové služby, podporované parametry, datové typy apod. Základní URI KOSapi-3 pro FEL je https://kosapi.feld.cvut.cz/api/3/, pro FIT https://kosapi.fit.cvut.cz/api/3/. Informace o autentizaci najdete na stránce o zabezpečení.
- Přidejte si do své RSS čtečky Atom Feed Novinky, abyste byli informováni o důležitých událostech a změnách v projektu. Vývojářům klientských aplikací velmi doporučuji tento zdroj sledovat.
- Pokud narazíte na chybu, napište prosím chybový report (předtím je nutné se přihlásit). Berte ovšem na vědomí, že služba je teprve ve fázi alfa testování. Nereportujte proto chyby u funkcionalit, ke kterým je v dokumentaci napsáno, že ještě nejsou dokončené.
Upozornění¶
KOSapi-3 je aktuálně ve stádiu alfa testování! Zatím obsahuje pouze data z exportu Bílé knihy. V následujících týdnech dojde k napojení na databázi KOS a přidání dat z rozsahu rozvrhů.