Main » History » Version 11

Jakub Jirůtka, 11/23/2011 05:02 PM
přidána upozornění k aktuálnímu stavu

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 9 Jakub Jirůtka
Zdrojem dat pro KOSapi jsou momentálně databázové exporty. 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. 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 10 Jakub Jirůtka
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í]].
15 1 Jakub Jirůtka
16 9 Jakub Jirůtka
*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. 
17 1 Jakub Jirůtka
18 11 Jakub Jirůtka
*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.
19 1 Jakub Jirůtka
20 9 Jakub Jirůtka
21 4 Jakub Jirůtka
h2. Jak začít?
22 4 Jakub Jirůtka
23 10 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":/projects/kosapi/issues/new (předtím je nutné se přihlásit), příp. e-mail na kosapi@fel.cvut.cz. 
24 1 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í]].
25 10 Jakub Jirůtka
* 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.
26 10 Jakub Jirůtka
* 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é.
27 10 Jakub Jirůtka
* 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).
28 4 Jakub Jirůtka
29 4 Jakub Jirůtka
30 4 Jakub Jirůtka
h2. Upozornění
31 1 Jakub Jirůtka
32 11 Jakub Jirůtka
Na konci června proběhlo jednání se zástupcem VIC o zpřístupnění DB pohledů v KOSu, které dopadlo úspěšně, tedy alespoň jsme si to všichni mysleli. Jenže dotyčný člověk tento souhlas dodatečně zatížil podmínkami, na které jsme nemohli přistoupit. Zvolili jsme tedy jinou cestu, a to podání žádosti přes děkany FEL a FIT na rektorát. Žádost děkani podali ke konci srpna a od té doby se táhnou jednání na úrovni rektorátu, která ještě pořád nebyla završena.
33 11 Jakub Jirůtka
34 11 Jakub Jirůtka
*KOSapi-3 je aktuálně ve stádiu alfa testování, a to pouze na doméně FIT.* Vzhledem k tomu, že ještě nemáme povolený přístup do KOSu, se kterým KOSapi-3 již počítá, tak je rozsah zdrojů a dat 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.
35 11 Jakub Jirůtka
36 11 Jakub Jirůtka
*KOSapi-2 na FEL bohužel neobsahuje aktuální data pro tento semestr!* Důvodem je nefunkčnost exportu Bílé knihy z KOSu. Tento problém je v řešení, ale jelikož zpřístupnění KOSu je stále „za dveřmi“ (bohužel už půl roku), tak kompetentní lidé nejsou příliš ochotní se tím zabývat. Zatím tedy nezbývá než čekat nebo využít KOSapi-1.