Main » Historie » Verze 7
Verze 6 (Jakub Jirůtka, 2011-08-26 04:14) → Verze 7/24 (Jakub Jirůtka, 2011-09-25 01:15)
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í.
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 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.
Dokumentaci starých verzí 1 a 2 naleznete prozatím na https://kosapi.feld.cvut.cz. *Verze 1 a 2 na FIT stále běží, pouze jejich dokumentace byla přesunuta na doménu FEL!* Základní URI zůstávají https://kosapi.fit.cvut.cz/api/1, resp. https://kosapi.fit.cvut.cz/api/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é.
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ů.
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í.
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 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.
Dokumentaci starých verzí 1 a 2 naleznete prozatím na https://kosapi.feld.cvut.cz. *Verze 1 a 2 na FIT stále běží, pouze jejich dokumentace byla přesunuta na doménu FEL!* Základní URI zůstávají https://kosapi.fit.cvut.cz/api/1, resp. https://kosapi.fit.cvut.cz/api/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é.
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ů.