Hlavní stránka¶

O projektu¶

KOSapi poskytuje aplikační rozhraní (API) v podobě RESTful webových služeb, které zprostředkovává přístup k vybrané části dat v databázi KOS. Odstraňuje nutnost zpracovávání exportů, neustálou duplikaci všech dat a potíže s jejich udržováním. RESTové služby staví na osvědčených konceptech webu jakožto distribuovaného prostředí vzájemně provázaných informací. KOSapi 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. Tvoří také jednu ze základních komponent nově vznikajícího Informačního systému ČVUT (IS ČVUT) a bylo zvoleno jako referenční řešení RESTful API pro všechny komponenty IS ČVUT.

Od verze 3.2 je KOSapi napojené přímo na databázi KOS a poskytuje přístup pro čtení k vybrané podmnožině dat týkající se bílé knihy, rozvrhů, studentů apod. Starší verze KOSapi získávají data z databázových exportů KOS.

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. Oddělení pro rozvoj FIT.

Co tu najdete?¶

Na tomto webu najdete dokumentaci KOSapi 3.2, 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 zatím v provozu a podporované, ale už se nebudou dále vyvíjet. Pokud je využíváte, přemigrujte prosím svou aplikaci na aktuální verzi 3.2.

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/3b/, pro FIT https://kosapi.fit.cvut.cz/api/3b/. 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).
• 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í¶

Aktuální verze 3.2 je zatím dostupná na URI https://kosapi.fit.cvut.cz/api/3b/! Dokumentace na tomto webu je platná pro tuto verzi, pouze je nutné zaměnit URI /api/3 za /api/3b. V nejbližší době dojde k nahrazení verze 3.0 na URI /api/3 za aktuální 3.2.