Main » History » Version 8

Jakub Jirůtka, 10/23/2011 04:44 PM

1 1 Jakub Jirůtka
h1. Hlavní stránka
2 1 Jakub Jirůtka
3 4 Jakub Jirůtka
h2. O projektu
4 2 Jakub Jirůtka
5 4 Jakub Jirůtka
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í.
6 1 Jakub Jirůtka
7 8 Jakub Jirůtka
Zdrojem dat pro KOSapi jsou momentálně databázové 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. 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.
8 8 Jakub Jirůtka
9 4 Jakub Jirůtka
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í).
10 4 Jakub Jirůtka
11 4 Jakub Jirůtka
12 4 Jakub Jirůtka
h2. Co tu najdete?
13 4 Jakub Jirůtka
14 4 Jakub Jirůtka
Na těchto stránkách najdete *dokumentaci* KOSapi-3, *bug tracking* a přehled novinek. Chcete-li zadat 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. 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.
15 1 Jakub Jirůtka
16 8 Jakub Jirůtka
*Dokumentaci předchozích verzí 1 a 2, které jsou stále v provozu, naleznete na https://kosapi.fit.cvut.cz/old.* Tyto verze už se nebudou dále vyvíjet.
17 1 Jakub Jirůtka
18 4 Jakub Jirůtka
19 4 Jakub Jirůtka
h2. Jak začít?
20 4 Jakub Jirůtka
21 4 Jakub Jirůtka
* 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. 
22 4 Jakub Jirůtka
* 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í]].
23 5 Jakub Jirůtka
* 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.
24 4 Jakub Jirůtka
* 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é.
25 4 Jakub Jirůtka
26 4 Jakub Jirůtka
27 4 Jakub Jirůtka
h2. Upozornění
28 3 Jakub Jirůtka
29 3 Jakub Jirůtka
*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ů.