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. 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 fakulty. 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 tomto webu najdete dokumentaci KOSapi-3, bug tracking a přehled novinek. Dokumentace je pro obě fakulty společná, jednotlivé instance FEL a FIT se liší pouze doménou v URL a daty, která poskytují. Chcete-li 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. Autorizace pro tento web a KOSapi jsou zcela nezávislé. Informace k autentizaci do webových služeb KOSapi najdete na stránce o zabezpečení.

*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 naleznete na staré wiki. Tyto verze jsou na obou fakultách stále v provozu a podporované, ale už se nebudou dále vyvíjet. Aktuální verze je ale ještě plně nenahrazuje, neboť zatím postrádá zdroje týkající se rozvrhů a studentů. Pakliže tato data potřebujete, použijte KOSapi-2, příp. KOSapi-1.

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é.
• Máte-li nějaké požadavky, které KOSapi aktuálně nesplňuje, napište je také do bug trackingu (fronta Požadavky).

Upozornění¶

Na konci června proběhlo jednání se zástupcem VIC o zpřístupnění DB pohledů v KOSu, které dopadlo úspěšně, tedy alespoň jsme si to všichni mysleli. Jenže dotyčný člověk tento souhlas dodatečně zatížil podmínkami, na které jsme nemohli přistoupit. Zvolili jsme tedy jinou cestu, a to podání žádosti přes děkany FEL a FIT na rektorát. Žádost děkani podali ke konci srpna a od té doby se táhnou jednání na úrovni rektorátu, která ještě pořád nebyla završena.

KOSapi-3 je aktuálně ve stádiu alfa testování. Vzhledem k tomu, že ještě nemáme povolený přístup do KOSu, se kterým KOSapi-3 již počítá, tak je rozsah zdrojů a dat omezen pouze na podmnožinu, kterou lze získat z exportu Bílé knihy. Jakmile dojde k napojení na KOS, přibudou zbývající zdroje týkající se rozvrhů, zkoušek, informací o studentech atd.

KOSapi-2 a KOSapi-3 na FEL bohužel neobsahuje aktuální data pro tento semestr! Důvodem je nefunkčnost exportu Bílé knihy z KOSu. Tento problém je v řešení, ale jelikož zpřístupnění KOSu je stále „za dveřmi“ (bohužel už půl roku), tak kompetentní lidé nejsou příliš ochotní se tím zabývat. Zatím tedy nezbývá než čekat nebo využít KOSapi-1.