PODMÍNKY POSKYTOVÁNÍ PŘÍSTUPU K PORTÁLU NAMĚŘENÝCH DAT POMOCÍ WEBOVÝCH SLUŽEB SPOLEČNOSTI ČEZ DISTRIBUCE, A. S.
PODMÍNKY POSKYTOVÁNÍ PŘÍSTUPU K PORTÁLU NAMĚŘENÝCH DAT POMOCÍ WEBOVÝCH SLUŽEB SPOLEČNOSTI ČEZ DISTRIBUCE, A. S. |
ČEZ Distribuce, a. s. Děčín - Děčín IV-Podmokly, Teplická 874/8, PSČ 405 02 IČO: 24729035, DIČ: CZ24729035
2 ZPŮSOB VYUŽITÍ SLUŽBY AZD - PND 6
2.1 REGISTRACE SLUŽBY AZD - PND 6
2.2 PRAVIDLA VYUŽÍVÁNÍ SLUŽBY AZD - PND 6
2.3 UKONČENÍ SLUŽBY AZD - PND 7
3.3 PROSTŘEDÍ IS POSKYTOVATELE 10
NÁVOD NA POUŽITÍ NÁSTROJE SAP UI 12
HISTORIE ZMĚN
Datum | Předmět změny | Kapitola | Verze |
19. 6. 2017 | Draft | 1.0.0 | |
15. 2. 2018 | Finální verze | 1.0.1 | |
30. 5. 2020 | Aktualizace popisů | 1.0.2 | |
Poznámka k systému verzování:
Pro verzování dokumentů je použito formátu MAJOR.MINOR.PATCH. Navyšování jednotlivých čísel verzí probíhá následovně:
• MAJOR - nastala změna, která není zpětně kompatibilní
• MINOR - nová funkcionalita se zachováním zpětné kompatibility
• XXXXX - oprava chyb se zachováním zpětné kompatibility
POUŽITÉ POJMY A ZKRATKY
Pojem / Zkratka | Popis |
AZD - PND | Přímé komunikační rozhraní mezi informačními systémy Poskytovatele a Objednatele umožňující dálkový přístup k Portálu naměřených dat pomocí webových služeb |
DIP | Distribuční portál ČEZ Distribuce, a. s. |
Objednatel | Žadatel o službu AZD - PND |
Poskytovatel | ČEZ Distribuce, a. s. |
IS Objednatele | Cílový informační systém Objednatele pro příjem dat |
IS Poskytovatele | Informační systém Poskytovatele pro odesílání dat |
Komunikační scénář | Schéma komunikace (požadavek/odpověď) mezi systémy Objednatele a Poskytovatele |
Manuální požadavek | Požadavek ze systému IS Objednatele na definovaný rozsah naměřených profilových dat |
Okamžitý typ úlohy | Odeslání naměřených profilových dat ze systému IS Poskytovatele okamžitě po načtení do Portálu naměřených dat |
Periodický typ úlohy | Odeslání naměřených profilových dat ze systému IS Poskytovatele dle nastaveného intervalu |
SOAP | Simple Object Access Protocol |
WSDL | Web Service Definition Language Poskytovatele |
XSD | XML Schema Definition |
1 ÚVOD
Tento dokument specifikuje principy a pravidla poskytování přístupu k Portálu naměřených dat pomocí webových služeb (dále jen AZD - PND) mezi ČEZ Distribuce, a. s. (dále jen IS Poskytovatele)
a systémem žadatele (dále jen IS Objednatele). Tato datová komunikace je založena na elektronické výměně strukturovaných zpráv mezi informačními systémy.
Cílem tohoto dokumentu je definovat komunikační scénáře, stanovit potřebná syntaktická pravidla a určit provozní pravidla pro poskytování služby AZD - PND.
Možnost AZD - PND zavedla společnost ČEZ Distribuce, a. s., v zájmu zkvalitnění a zefektivnění poskytovaných služeb na svém distribučním území.
AZD - PND je umožněna pouze žadatelům, kteří splní technické a organizační náležitosti, popsané tímto dokumentem.
Pomocí komunikačních scénářů je žadatelům umožněno:
▪ získávat naměřená profilová data okamžitě po načtení do portálu naměřených dat,
▪ získávat naměřená profilová data periodicky v intervalu den, týden, měsíc,
▪ zasílat manuální požadavky na naměřená profilová data.
Rozsah poskytnutých naměřených profilových dat plně odpovídá vyhlášce č. 82/2011 Sb.
2 ZPŮSOB VYUŽITÍ SLUŽBY AZD - PND
2.1 Registrace služby AZD - PND
Registrace přístupu ke službě AZD - PND probíhá následujícím způsobem:
1. Žádost o zpřístupnění AZD - PND
Objednatel předá Poskytovateli vyplněný formulář s žádostí o umožnění služby AZD - PND, definicí typu požadovaných dat a kontaktními údaji své společnosti. Tento krok je platný také v případě žádosti o změnu, případně ukončení využívání služby AZD - PND.
2. Předání certifikátu IS Objednatele
Žadatel předá osobně nebo prostřednictvím DIP Poskytovateli veřejnou část komerčního systémového certifikátu pro identifikaci systému žadatele (IS Objednatele).
3. Předání certifikátu IS Poskytovatele
Poskytovatel předá osobně, nebo prostřednictvím DIP na kontaktní osobu Objednatele veřejnou část komerčního systémového certifikátu pro identifikaci systému Poskytovatele (pokud je to ze strany Objednatele požadováno).
4. Registrace žadatele u Poskytovatele
Po procesu registrace AZD - PND a technickém nastavení IS Poskytovatele bude Objednatel ze strany Poskytovatele informován prostřednictvím DIP o připravenosti datové komunikace.
5. Testování AZD - PND
Po této registraci bude Objednatel vyzván k testování komunikace mezi službou AZD - PND a IS Objednatele.
6. Přechod do řádného provozu
Po úspěšném otestování komunikace a potvrzení obou stran je Objednatel informován o ukončení testovacího provozu a přechodu do řádného provozu.
7. Provozování datové komunikace
Od tohoto okamžiku je Objednatel ve svém IS Objednatele oprávněn využívat AZD - PND.
2.2 Pravidla využívání služby AZD - PND
1. Aktuálně platná verze Pravidel pro provozování služby AZD - PND je zveřejňována na xxx.xxxxxxxxxxxxx.xx.
2. Objednatel je povinen užívat datových služeb s ohledem na ostatní uživatele služby AZD - PND.
3. Objednatel bere na vědomí, že informace o jeho komunikaci se službou AZD - PND jsou ukládány pro účely administrativy, provozu, statistik, monitoringu a bezpečnosti.
4. Objednatel nesmí prostřednictvím svého účtu povolit přístup jinému subjektu či osobě poskytnutím svých přístupových údajů bez souhlasu Poskytovatele.
5. Při práci s datovými službami musí být zohledněno množství a objem komunikovaných zpráv tak, aby Objednatel, který službu AZD – PND používá, nezatěžoval systém zbytečnou
datovou komunikací - například odesíláním nadměrného množství manuálních požadavků.
6. Poskytovatel si vyhrazuje právo dozorovat využívání služby AZD - PND jednotlivými systémy Objednatele dle interních limitů. Při déletrvajícím překračování těchto limitů bude Poskytovatel informovat kontaktní osobu Objednatele o této skutečnosti. Pokud se situace nezlepší nebo Objednatel svůj provoz nezdůvodní, může Poskytovatel přikročit k dočasné deaktivaci služby AZD - PND, o které bude informována kontaktní osoba.
7. Služba AZD - PND je provozována nepřetržitě v režimu 24 x 7 s výjimkou odstávek a nutné údržby. V této době nemusí být systém dostupný.
8. Upozornění na plánované změny datových služeb jsou Poskytovatelem publikovány jako
stručná upozornění na budoucí změny aplikačního rozhraní. Součástí změn rozhraní mohou být úpravy, které povedou na úpravu Technické specifikace.
9. Pokud jsou implementované změny rozsáhlé, může Poskytovatel trvat na vykonání integračních testů systémů Objednatele pro zvolené oblasti.
10. Pokud je výskyt chyb v komunikaci s daným IS Objednatele nad obvyklý rámec, může Poskytovatel trvat na vykonání opakovaných integračních testů pro zvolené oblasti.
11. Změny, které neovlivňují existující funkcionalitu, mohou být nasazeny a oznámeny kdykoli.
12. Změny, které jakýmkoli způsobem mění existující funkčnost datových služeb, nebo přihlášení k nim, jsou zveřejňovány obvykle dva měsíce před jejich nasazením, nebrání-li tomu mimořádné provozní či bezpečnostní důvody.
13. Pro testování či v případě technických potíží se obracejte na e-mail xxxxxxxxx@xxxxxxxxxxxxx.xx nebo telefonicky na x000 000 000 000.
2.3 Ukončení služby AZD - PND
V případě, že ze strany IS Objednatele dochází k porušování pravidel využívání služby AZD - PND, je Poskytovatel oprávněn poskytování služby AZD - PND pozastavit. O této skutečnosti bude Objednatel informován prostřednictvím DIP.
3 POPIS VÝMĚNY DAT
V této kapitole jsou popsány základní logické a technické aspekty komunikace mezi systémy Poskytovatele a Objednatele.
3.1 Komunikační scénáře
AZD – PND obsahuje v principu 4 základní typy zpráv a je založena na 2 následujících základních komunikačních scénářích:
3.1.1 Komunikační scénář manuálního vyžádání dat z IS OBJEDNATELE
REQ1 - REQUEST
Zpráva je odesílána z IS Objednatele na IS Poskytovatele. Jedná se o iniciální zprávu s dotazem na vyžádání naměřených profilových dat. Iniciátorem komunikace je v tomto případě IS Objednatele.
RET1 - RETURN REQEST
Jedná se o potvrzení od IS Poskytovatele o doručení iniciální zprávy zaslané ze systému IS Objednatele.
RES1 - RESPONSE
Zpráva obsahuje výsledek požadavku ze systému IS Objednatele (tj. naměřená profilová data) a je zasílána směrem od IS Poskytovatele do systému IS Objednatele.
V případě zamítavé odpovědi dostane IS Objednavatele informaci o chybách v iniciální zprávě, kvůli kterým došlo k zamítnutí žádosti.
RET2 - RETURN RESPONSE
Zprávou IS Objednavatele potvrzuje přijetí dat od IS Poskytovatele.
3.1.2 Komunikační scénář okamžitého a periodického zasílání profilových dat z IS Poskytovatele
RES1 - RESPONSE
Zpráva je odesílána od IS Poskytovatele do IS Objednatele. Jedná se o iniciální zprávu s naměřenými profilovými daty dle okamžitého nebo periodického způsobu zasílání dat. Zpráva obsahuje naměřená profilová data a je vyvolána změnou naměřených profilových dat v IS Poskytovatele nebo se jedná o odesílání dat v definované periodě.
RET2 - RETURN RESPONSE
Zprávou IS Objednatele potvrzuje přijetí dat od IS Poskytovatele.
3.2 Technologie komunikace
Elektronická komunikace s Poskytovatelem je založena na obousměrné komunikaci. Tedy platí, že:
▪ Poskytovatel vystavuje webové služby a systém IS OBJEDNATELE je volá (připojuje se k nim),
▪ Poskytovatel volá webové služby na IS OBJEDNATELE.
3.2.1 Komunikace IS Objednatele -> IS Poskytovatele
IS Poskytovatele publikuje asynchronní webové služby pro zasílání Manuálních požadavků na naměřená profilová data. Dále Poskytovatel poskytuje popis datových struktur ve formátu XSD, který jednoznačně definuje podobu webové služby vystavené na straně IS Objednatele.
Každá publikovaná webová služba, má svou URL adresu a popis webové služby, která je dodávána ve formě Connect stringu (URL adresa) a standardního WSDL souboru pro každou vystavenou webovou službu na straně IS Poskytovatele. Webové služby jsou dostupné:
▪ z veřejné sítě internet,
▪ pomocí VPN tunelu.
Technicky jsou webové služby vystavěny na transportním protokolu http/https a message protokolu SOAP verze 1.1.
IS Objednatele generuje zprávy odpovídající dodané definici a předává je na vstupní bod/ body IS Poskytovatele, vystavenou webovou službu/ vystavené webové služby. Při každém volání se příslušný externí systém autentizuje. Autentizace je technologicky prováděna jako klientská autorizace klientským certifikátem. Jako klientský certifikát je požadován komerční systémový certifikát, vydávaný podporovanou certifikační autoritou (viz seznam podporovaných certifikačních autorit). Na straně IS Poskytovatele je pro každý externí systém vytvořen uživatelský účet, ke kterému je přiřazena dodaná veřejná část komerčního systémového certifikátu.
IS Poskytovatele akceptuje komerční certifikáty, které vydaly akreditované certifikační autority:
▪ Česká pošta s.p. - „PostSignum Public CA 2“ (xxxx://xxx.xxxxxxxxxx.xx/),
▪ EIdentity a.s. - „CCAeID2 - Commercial Certificate Authority“ (xxxx://xxx.xxxxxxxxx.xx/).
Vlastní komunikace je zahajována na základě odeslání Manuálního požadavku na naměřená profilová data z IS Objednatele, nebo Okamžitým, či Periodickým odesláním naměřených profilových dat. Každá příchozí zpráva je na vstupním bodě do IS Poskytovatele validována dle platné verze XSD. Jako potvrzení o úspěšném přijetí zprávy IS Poskytovatele je tímto odeslán technický kód HTTP 200 OK.
3.2.2 Komunikace IS Poskytovatele -> IS Objednatele
IS Poskytovatele volá vystavené webové služby na IS Objednatele v případech:
▪ odeslání naměřených profilových dat okamžitě po načtení do odečtového systému,
▪ odeslání naměřených profilových dat periodicky v intervalu den, týden, měsíc.
Objednatel musí ve svém IS Objednatele zajistit vytvoření dvou webových služeb dle definice struktury dodané ve formátu XSD uvedené v přílohách tohoto dokumentu. Technické vlastnosti implementované služby jsou:
▪ komunikace standardem SOAP 1.1,
▪ autentizace pomocí certifikátu IS Poskytovatele, pokud je požadováno systémem Objednatele; v úvahu přichází i případné použití Basic autentizace, pokud bezpečnostní politiky Objednatele tento způsob dovolují.
V rámci procesu „Žádosti o automatické získávání dat“ proběhne předání následujících informací:
▪ předání veřejné části certifikátu, kterým se IS Poskytovatele bude autentizovat při navazování spojení s webovými službami IS Objednatele,
▪ předání veřejné části certifikátu serveru na němž budou umístěny webové služby Objednatele a na který bude navazováno SSL spojení (je očekávána podpora standardu TLS 1.2),
▪ v případě publikace webových služeb ve veřejném internetu je předán kompletní rozsah IP adres, ze kterých IS Objednatele navazuje spojení s webovými službami IS Poskytovatele, a to pro testovací i produkční prostředí,
▪ technické informace pro vytvoření VPN tunelu mezi IS Objednatele a IS Poskytovatele, V případě, že bude vytvářeno permanentní spojení mezi IT prostředími Objednatele a Poskytovatele na bázi VPN tunelu – technologie Cisco IPSec.
3.3 Prostředí IS Poskytovatele
Technické parametry produktivního prostředí, internetové domény, IP adresy apod. budou Objednateli sděleny bezprostředně po úspěšně dokončené registraci u Poskytovatele. Primárně budou dodány následující informace:
- rozsah IP adres, ze kterých bude vedena komunikace vůči systému Objednatele,
- veřejná část certifikátu serveru na kterém budou vystaveny webové služby, včetně všech vnořených certifikátů, potřebných pro navázání a ověření SSL spojení,
- veřejná část certifikátu pro klientskou autorizaci do systému Objednatele,
- URL adresy, včetně plné cesty (connect string) pro jednotlivé vystavené webové služby na straně systému Poskytovatele.
4 TESTOVACÍ POSTUPY
Testování připravenosti IS Objednatele na datovou komunikaci s IS Poskytovatele je povinným krokem registrace pro umožnění služby AZD - PND. Rozsah testované funkcionality, testovací postupy a termíny provedení testů jsou zástupci Poskytovatele stanoveny individuálně po dohodě s Objednatelem na základě zvolených datových služeb a kapacitních možností pracovníků Poskytovatele.
Na straně IS Poskytovatele budou vystaveny testovací webové služby, které slouží k ověření implementace na straně systému Objednavatele a následně k akceptačnímu testování. Po jeho úspěšném dokončení, bude vydáno povolení k přechodu do produktivního provozu.
Pro produktivní provoz bude sloužit sada produktivních webových služeb vystavených na straně systému Poskytovatele.
Volání vystavených webových služeb bude akceptováno pouze z předem dodaného / povoleného rozsahu IP adres, a to jak pro produktivní prostředí, tak i pro prostředí testovací.
Pro usnadnění testování chování vystavených webových služeb na straně systému Objednatele je možné použít klienta webové služby vytvořeného v prostředí aplikace SOAP UI. Detailní návod na použití nástroje SOAP UI je uveden v příloze.
Pro účely testování budou Objednateli připravena v systému testovací data a budou mu sděleny jejich základní identifikátory (např. EAN odběrného místa, k němuž lze žádat o naměřená data).
5 PŘÍLOHY Definice zpráv
Definice podrobného obsahu zpráv, číselníky apod.
Formát MS Excel. Název souboru je vytvořen podle konvence CEZ_AZD_PND.xlsx.
Popis funkcí definovaných prostřednictvím WSDL.
Názvy souborů jsou vytvořeny podle konvence
<ID_služby_Poskytovatele>_DataStructure_<ID_odesílajícícho_systému>_<ID_přijímacího_systému>
_<ID_zprávy>_<ID_verze>_<Datum>.wsdl
Název souboru | Popis |
AZD_DataStructure_ExtSupplier_PND_MeasuredDataRequest_OutAsyn c_v01_2019-07-16.wsdl | WSDL definice webové služby pro příjem požadavku na zasílání naměřených dat |
AZD_DataSructure_ExtSupplier_PND_MeasuredDataResponseConfirmat ion_OutAsync_v01_2019-07-16.wsdl | WSDL definice webové služby pro příjem potvrzení o přijetí naměřených dat |
Popis struktur zpráv ve formátu XSD.
Názvy souborů jsou vytvořeny podle konvence
<ID_služby_Poskytovatele>_DataStructure_<ID_odesílajícícho_systému>_<ID_přijímacího_systému>
_<ID_zprávy>_<ID_verze>_<Datum>.xsd
Název souboru | Popis |
AZD_DataStructure_PND_ExtSupplier_MeasuredDataRequestConfirmati on_InAsync_v01_2019-07-16.xsd | XSD definice datové struktury pro příjem potvrzení požadavku na zasílání naměřených dat. |
AZD_DataStructure_PND_ExtSupplier_MeasuredDataResponse_InAsyn c_v01_2019-07-16.xsd | XSD definice datové struktury pro příjem naměřených dat. |
Příklady obsahu zpráv ve formátu XML.
Názvy souborů jsou vytvořeny podle konvence
<ID_služby_Poskytovatele>_<ID_odesílajícícho_systému>_<ID_přijímacího_systému>_<ID_zprávy>_
<ID_verze>_<Datum>.xml
Název souboru | Popis |
AZD_ExtSupplier_PND_MeasuredDataRequest_v01_2020-04-30.xml | Příklad požadavku na naměřená data zasílaného systémem Objednavatele |
AZD_PND_ExtSupplier_MeasuredDataRequestConfirmation_v01_2020- 04-30.xml | Příklad potvrzení o přijetí požadavku na naměřená data zasílaného systémem Poskytovatele |
AZD_PND_ExtSupplier_MeasuredDataResponse_v01_2020-04-30.xml | Příklad naměřených dat zasílaných systémem Poskytovatele |
AZD_ExtSupplier_PND_MeasuredDataResponseConfirmation_v01_2020- 04-30.xml | Příklad potvrzení přijetí naměřených dat zasílaného systémem Objednavatele |
Návod na použití nástroje SAP UI
Detailní návod na použití nástroje SOAP UI pro otestování chování vystavených webových služeb na straně systému Poskytovatele 4_AZD_PND_Integration_Návod na používání SoapUI 5_v01_2020-04- 30.docx.
6 KONTAKTY AZD - PND
Pro testování, řešení technických potíží a dalších dotazů ke službě AZD - PND se obracejte na e-mail xxxxxxxxx@xxxxxxxxxxxxx.xx nebo telefonicky na x000 000 000 000.