Main » History » Version 9

Version 8 (Jakub Jirůtka, 10/23/2011 04:44 PM) → Version 9/22 (Jakub Jirůtka, 10/23/2011 10:43 PM)

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 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. 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 fakulty. 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(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 těchto stránkách najdete *dokumentaci* KOSapi-3, *bug tracking* a přehled novinek. Nenechte se zmást doménou, každá fakulta má sice svou instanci KOSapi, ale *web je pro obě fakulty společný*. Chcete-li zadat zadat požadavek nebo reportovat chybu, přihlaste *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
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 2, které jsou stále v provozu, naleznete na* https://kosapi.fit.cvut.cz/old. na https://kosapi.fit.cvut.cz/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.

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


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