Main » History » Version 16

Jakub Jirůtka, 08/21/2012 11:48 AM
aktualizace pro v3.2

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 15 Jakub Jirůtka
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) a bylo zvoleno jako *referenční řešení RESTful API pro všechny komponenty IS ČVUT.*
6 1 Jakub Jirůtka
7 15 Jakub Jirůtka
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ávají data z databázových exportů KOS.
8 8 Jakub Jirůtka
9 15 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. Oddělení pro rozvoj 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 15 Jakub Jirůtka
Na tomto webu najdete *dokumentaci* KOSapi 3.2, *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 15 Jakub Jirůtka
*Dokumentaci předchozích verzí 1 a 2 naleznete* na "staré wiki":/old.  Tyto verze jsou na obou fakultách zatím v provozu a podporované, ale už se nebudou dále vyvíjet. Pokud je využíváte, přemigrujte prosím svou aplikaci na aktuální verzi 3.2.
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 16 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/3b/, pro FIT(Fakulta informačních technologií) https://kosapi.fit.cvut.cz/api/3b/. 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 16 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).
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 11 Jakub Jirůtka
h2. Upozornění
31 11 Jakub Jirůtka
32 15 Jakub Jirůtka
*Aktuální verze 3.2 je zatím dostupná na URI {{base_url}}/api/3b/!* Dokumentace na tomto webu je platná pro tuto verzi, pouze je nutné zaměnit URI /api/3 za /api/3b. V nejbližší době dojde k nahrazení verze 3.0 na URI /api/3 za aktuální 3.2.