Nastavení připojení k EWP síti

Připojení do EWP sítě probíhá přes tzv. "manifest". Instituce na svém serveru zveřejní soubor (manifest), který obsahuje základní informace, cesty k jednotlivým zveřejněným API a certifikáty pro komunikaci. 

Návod na připojení

Následující text obsahuje návod na připojení do EWP sítě. Základní kroky jsou stejné, jak pro připojení do testovací DEV EWP sítě, tak do produkční EWP sítě. Postup se liší až v závěrečném kroku, ve kterém instituce žádá o připojení do zvolené sítě. 

Nastavení parametrů

Nejprve je nutné nastavit parametry v databázi.

Identifikační údaje:

• EWP_ERASMUS_CHARTER - Obsahuje identifikátor Erasmus Charter (EUC, ECHE, atd.). Např. 12345-EPP-1-2014-1-CZ-EPPKA3-ECHE. Od roku 2021 se kód změnil na "Proposal Number", které najdete uvedené v dokumentu na stránce Higher education institutions holding an ECHE. Např. 101012323
  
• EWP_ERASMUS_PIC - Devítimístný Personal Identifier Code (PIC).
• EWP_ERASMUS_SCHAC - Povinný identifikátor v EWP síti, který jednoznačně identifikuje organizaci. Je vytvořen podle jména internetové domény, kterou má organizace registrovanou. Např. zcu.cz pro Západočeskou univerzitu.
• EWP_ERASMUS_PREDCHOZI_SCHAC - Obsahuje seznam dříve používaných SCHAC ID, které byly uvedeny v parametru EWP_ERASMUS_SCHAC. Aktuálně není potřeba vyplnit, protože dřívější SCHAC ID neexistovalo.

Konfigurace:

• EWP_ZVEREJNENA_API - Umožňuje nastavit, která API se budou v EWP síti používat. Aktuálně je dostupná pouze podmnožina vybraných API.
  

V budoucnu mohou další parametry přibývat. 

Volba certifikátu

Aplikace pro svůj provoz potřebuje certifikát pro TLS ověření klienta. V základní konfiguraci aplikace používá certifikát, který se na serveru již nachází. Pokud tento certifikát použít nechcete, můžete si jej změnit. Stačí si nechat vystavit nový certifikát, nejlépe podepsaný certifikační autoritou, a následně ho umístit na server k již existujícímu serverovému certifikátu. V konfiguračním souboru je následně nutné nastavit k tomuto certifikátu cestu. Napiště nám do RT, jak se soubor s certifikátem jmenuje a my Vám jeho použití nastavíme. 

To samé platí o RSA šifrovacích klíčích, které aplikace používá k HTTP podepisování požadavků a odpovědí při výměně dat mezi klienty. V základní konfiguraci aplikace používá klíče, které patří k certifikátu serveru. Pokud si pro komunikaci připravíte certifikát nový, budou se pro HTTP podepisování používat i nové RSA klíče. Jejich použití je také nutné nastavit v konfiguračním souboru.

Nastavení firewallu

Jednotlivá API budou přistupná na portu 8843 (pozor neplést s portem 8443). Proto je nutné tento port ve firewallu povolit pro příchozí komunikaci. Povolení portu je nutné nastavit jak pro stroj, kde běží modul WS, tak i případně v centrálním firewallu, pokud je používán.

Jelikož nikde není specifikováno, na kterých portech by měla komunikace probíhat, mohou různé instituce používat různé porty. Obecně lze použité porty zjistit z katalogu na stránce https://dev-registry.erasmuswithoutpaper.eu/ (příp. https://registry.erasmuswithoutpaper.eu/) Aktuálně většina institucí komunikuje na standardních portech a existují jen čtyři další porty, na kterých komunikace probíhá. Nicméně další porty mohou přibývat, a proto zde nemůžeme vystavit seznam, podle kterého byste si mohli povolit ve firewallu porty pro odchozí komunikaci, pokud tuto komunikaci omezujete.

Test nastavení

Je vhodné otestovat, zda je vše nastaveno správně. Do prohlížeče je možné zadat URL manifest souboru a podívat se, zda se vrátí XML soubor s identifikačními údaji univerizity a zveřejněnými API.

<url_webu>:8843/ws/services/ewp/manifest

Dále je možné funkčnost ověřit na jednom ze základních API. Základní informace o instituci nevyžadují autentizaci. Proto je možné do prohlížeče zadat URL podle následujícího vzoru a podívat se, zda se vrátí data o instituci.

<url_webu>:8843/ws/services/ewp/institutions?hei_id=<EWP_ERASMUS_SCHAC>

Připojení k testovací EWP síti

Pro připojení k testovací EWP síti stačí poslat e-mail na ewp-tech@lists.erasmuswithoutpaper.eu se žádostí o připojení do DEV EWP sítě, ve kterém bude uvedena cesta k manifest souboru. Aplikace manifest vygeneruje na url

<url_webu>:8843/ws/services/ewp/manifest

Také se odkazujte na nás, jako na vývojáře vašeho připojení. Do DEV EWP sítě připojujte prosím jen svoje testovací/demo databáze. 

Po připojení svoji univerzitu naleznete v seznamu na stránce DEV HEI/API Coverage Matrix.

Připojení k EWP síti

Podrobný postup pro připojení do EWP sítě je uveden na wiki stránce European University Foundation (EUF) EWP Network Entry procedure. Zde je uvedena jeho zkrácená verze.

Vstup podmiňuje splnění několika základních podmínek. Pokud žádající instituce používá tzv. "ověřeného poskytovatele softwaru" uvedeného na wiki EUF na stránce 3rd party software, nemusí procházet kompletními technickými požadavky. 

1. Podání žádosti
   
   1. Zástupce instituce musí podepsat podmínky užití a jako PDF soubor je poslat koordinátorovi projektu EWP (Valere Meus - valere.meus@uni-foundation.eu).
   2. Také musí dodat URL, na kterém se nachází manifest soubor. Viz předchozí podkapitola (Připojení k testovací EWP síti), avšak místo testovací/demo databáze se bude jednat o produkční databázi.
   3. (Zatím nechtěli) Dále musí dodat kontakt na dvě osoby, které jsou zodpovědné za aplikaci, první osoba je zodpovědná za data (někdo ze zahraničního oddělení), druhá osoba aplikaci rozumí na technické úrovni kvůli řešení problémů (administrátoři).
2. Ověření
   1. EWP komise následně ověří, zda je instituce držitelem Erasmus charter, který se aktivně podílí v Erasmus programu.
   2. Dále ověří, zda SCHAC kód patří žádající instituci.
   3. Dále ověří, zda je doména, která hostuje manifest soubor, vlastněna žádající institucí nebo jejím softwarovým poskytovatelem.
3. Splnění technických požadavků
   1. Nejprve je URL manifestu přidána do DEV registru.
   2. Provedou se automatizované testy.
   3. (Nevyžadovali) Žádající instituce provede testy se třemi partnerskými institucemi.
   4. EWP technický tým provede další testy předtím, než instituci přídá do produkčního registru.

Po připojení svoji univerzitu naleznete v seznamu na stránce HEI/API Coverage Matrix.

Konkrétní situace

Univerzita je již připojena do DEV EWP sítě

Tato situace se týká univerzit, které již dříve zažádaly o připojení do testovací EWP sítě.

Připravte si:

1. Podepsané podmínky užití (dříve nazývané Memorandum of Understanding).
2. URL k manifestu na produkčním serveru: <url_webu>:8843/ws/services/ewp/manifest

Vzor e-mailu:

Dear Mr Meus,
we would like to connect the <NAZEV_UNIVERZITY> to the EWP production Registry Service. Our EWP connector is implemented by the University of West Bohemia which has already been connected to the EWP production Registry Service. We are using the same version of the connector. Our university is connected to the DEV Registry Service.

Our production manifest file is located at <URL_WEBU>:8843/ws/services/ewp/manifest

A signed agreement of Terms of Use is attached to this e-mail.

Univerzita není připojena do DEV EWP sítě a chce tam připojit

Tato situace se týká univerzit, které ještě nežádaly o připojení do testovací EWP sítě, ale mají testovací/demo databázi, kterou by tam chtěli připojit.

Připravte si:

1. Podepsané podmínky užití (dříve nazývané Memorandum of Understanding).
2. URL k manifestu na testovacím/demo serveru: <url_webu>:8843/ws/services/ewp/manifest
3. URL k manifestu na produkčním serveru: <url_webu>:8843/ws/services/ewp/manifest

Vzor e-mailu:

Dear Mr Meus,

we would like to connect the <NAZEV_UNIVERZITY> to the EWP production Registry Service. Our EWP connector is implemented by the University of West Bohemia which has already been connected to the EWP production Registry Service. We are using the same version of the connector. 

Our DEV manifest file is located at <URL_WEBU>:8843/ws/services/ewp/manifest and our production manifest file is located at <URL_WEBU>:8843/ws/services/ewp/manifest

A signed agreement of Terms of Use is attached to this e-mail.

Univerzita není připojena do DEV EWP sítě a nechce tam připojit

Tato situace se týká univerzit, které nemají testovací/demo databáze, které by mohly připojit do testovací EWP sítě a budou se chtít připojit pouze do produkční EWP sítě.

Připravte si:

1. Podepsané podmínky užití (dříve nazývané Memorandum of Understanding).
2. URL k manifestu na produkčním serveru: <url_webu>:8843/ws/services/ewp/manifest

Vzor e-mailu:

Dear Mr Meus,

we would like to connect the <NAZEV_UNIVERZITY> to the EWP production Registry Service. Our EWP connector is implemented by the University of West Bohemia which has already been connected to the EWP production Registry Service. We are using the same version of the connector. We do not have DEV server to connect to the DEV Registry Service therefore we would like to connect only to the production Registry Service.

Our production manifest file is located at <URL_WEBU>:8843/ws/services/ewp/manifest

A signed agreement of Terms of Use is attached to this e-mail.

Erasmus Dashboard

Univerzity byly dříve požádány o otestování nových funkcí v Erasmus Dashboard (externí nástroj pro připojení do EWP sítě pro univerzity, které nemají informační systém na správu mobilit). Proto se mohlo stát, že se některé již do EWP sítě přes Dashboard připojily. Každá služba (API) v EWP síti může být napojena pouze přes jeden systém. Pokud jsou některé služby napojené již přes Dashboard, není možné je připojit přes IS/STAG. To lze vyřešit nastavením parametru EWP_ZVEREJNENA_API, ve kterém se omezí, jaké služby se mají z IS/STAG napojit. Druhou možností je připojení v Erasmus Dashboard k EWP síti zrušit.

Zatím se připojené služby přes IS/STAG a Dashboard nepřekrývají. To se ale může brzy změnit, proto je vhodné tuto situaci řešit.