KOSapi

h1. Hlavní stránka

h2. 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).

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ávaly data z databázových exportů KOS (již jsou mimo provoz).

Aktuálně jsou dostupné instance pro FEL(Fakulta elektrotechnická), FIT(Fakulta informačních technologií) a FBMI(Fakulta biomedicínského inženýrství), prakticky není problém spustit instance i pro další fakulty ČVUT. Provoz KOSapi technicky zajišťuje SVTI(Středisko vědecko-technických informací) FEL(Fakulta elektrotechnická), resp. Oddělení pro rozvoj FIT(Fakulta informačních technologií).

h2. Co tu najdete?

Na tomto webu najdete *dokumentaci* aktuální verze KOSapi, *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 Heslem ČVUT* - ověřování probíhá proti LDAP(Lightweight Directory Access Protocol) serveru "Usermap":https://usermap.cvut.cz. Autorizace pro tento web a KOSapi jsou zcela nezávislé. Informace k autentizaci do webových služeb KOSapi najdete na stránce o [[Security|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. 

h2. 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":/projects/kosapi/issues/new (předtím je nutné se přihlásit), příp. e-mail na kosapi@fit.cvut.cz. *V každém případě si pozorně pročtěte seznam [[URLParameters|URL parametrů]]!*

* Na stránce [[Resources|RESTful zdroje]] najdete adresy jednotlivých zdrojů webové služby, podporované parametry, datové typy apod. Základní URI(Uniform Resource Identifier) KOSapi-3 pro FEL(Fakulta elektrotechnická) je https://kosapi.feld.cvut.cz/api/3/, pro FIT(Fakulta informačních technologií) https://kosapi.fit.cvut.cz/api/3/. Informace o autentizaci najdete na stránce o [[Security|zabezpečení]].

* Přidejte si do své RSS čtečky Atom Feed "Novinky":/projects/kosapi/news.atom, 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":/projects/kosapi/issues/new (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":/projects/kosapi/issues/new (fronta Požadavky).