Historie

Hlavní stránka

O projektu

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.

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ávaly data z databázových exportů KOS (již jsou mimo provoz).

Aktuálně jsou dostupné instance pro FEL, FIT a FBMI, prakticky není problém spustit instance i pro další fakulty ČVUT.

Co tu najdete?

Na tomto webu najdete dokumentaci aktuální verze KOSapi a přehled novinek. Dokumentace je pro všechny fakulty společná, jednotlivé instance FEL, FIT a FBMI se liší pouze doménou v URL a daty, která poskytují.

Instance KOSapi

KOSapi FIT

Base URI: https://kosapi.fit.cvut.cz/api/3
Autorizační server: https://auth.fit.cvut.cz

Provoz KOSapi FIT technicky zajišťuje ICT oddělení FIT.

KOSapi FEL

Base URI: https://api-test.fel.cvut.cz/kosapi/v3
Autorizační server: https://auth.fel.cvut.cz

Provoz zajišťuje SVTI FEL, konkr. Jakub Jirůtka.

Stará instance na https://kosapi.feld.cvut.cz/api/3, která se autentizuje vůči https://auth.fit.cvut.cz, již není podporovaná. Pokud ji ještě používáte, obraťte se na .

Jak začít?

  • Nejprve si pročtěte dokumentaci na této wiki. Pokud zde na některou otázku nenajdete odpověď, napište správci konkrétní instance (viz výše). V každém případě si pozorně pročtěte seznam URL parametrů!
  • Na stránce RESTful zdroje najdete adresy jednotlivých zdrojů webové služby, podporované parametry, datové typy apod. Základní URI KOSapi-3 pro FEL je https://kosapi.feld.cvut.cz/api/3/, pro FIT https://kosapi.fit.cvut.cz/api/3/. Informace o autentizaci najdete na stránce o zabezpečení.
  • Přidejte si do své RSS čtečky Atom Feed Novinky, 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 nebo máte nějaké požadavky, které KOSapi aktuálně nesplnuje, napište prosím správci konkrétní instance (viz výše).

Kalendáře

Výukové kalendáře (export do iCalendar aj.) poskytuje služba Sirius.

Také k dispozici: PDF HTML TXT