h1. Hlavní stránka

h2. O projektu

KOSapi poskytuje *aplikační rozhraní* v podobě RESTful *webových služeb*, které zprostředkovává přístup k vybrané části dat v *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, ale už ne na dlouho. Památného dne 9. 3. 2012 jsme po více než 9 měsících složitých jednání konečně získali přístup k databázovým pohledům v KOSu. Aktuálně vyvíjená verze KOSapi-3.2 už pracuje přímo nad KOSem a v nejbližší době bude nasazena do zkušebního provozu. Stále se jedná pouze o přístup ke čtení, nicméně už tu svítá naděje pro získání přístupu i pro zápis.

Aktuálně jsou dostupné instance pro FEL(Fakulta elektrotechnická) a FIT(Fakulta informačních technologií), 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. IT oddělení FIT(Fakulta informačních technologií).


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

*Dokumentaci předchozích verzí 1 a 2 naleznete* na "staré wiki":/old.  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.


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@fel.cvut.cz. 
* 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). 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":/projects/kosapi/issues/new (fronta Požadavky).


h2. Upozornění

KOSapi-3 je aktuálně ve stádiu alfa testování a rozsah dat je 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.