API služby

Informácie pre dodávateľov elektriny o API službách spoločnosti Západoslovenská distribučná a podmienkach ich využívania

Naše API služby poskytujú dodávateľom elektriny efektívny spôsob automatizovaného spracovania dát. Umožňujú priame napojenie na rozhranie poskytujúce dáta a ich následné spracovanie bez nutnosti zásahu obsluhy. Dáta môžu dodávatelia importovať priamo do svojej databázy a následne s nimi pracovať.

Upozornenie

API služby, zverejnené na tejto stránke, sú v súčasnosti v testovacom režime. Poskytovanie dát dodávateľom elektriny prostredníctvom API služieb prebieha podľa podmienok, ktoré sú popísané v dokumente Podmienky používania.

GitLab je štandardizovaný nástroj na verziovanie kódu pre developerov. Pokiaľ chcete získať prístup do privátneho GitLabu ZSD, kontaktujte nás na api@zsdis.sk a uveďte nasledovné údaje:

  • názov dodávateľa,
  • EIC kód dodávateľa,
  • číslo platnej Rámcovej distribučnej zmluvy (RDZ), uzatvorenej s našou spoločnosťou, kontaktnú osobu, uvedenú v RDZ (meno, priezvisko, e-mail a telefonický kontakt).

Referenčný klient je ukážková implementácia získavania dát zo ZSDIS API. Pre stiahnutie referenčnej implementácie sa musíte prihlásiť do privátneho GitLabu ZSD. Tu nájdete referenčnú implementáciu klienta, prostredníctvom ktorého si môžete služby vyskúšať.

Zoznam našich aktuálne dostupných REST API služieb:

  1. Hello – testovacia služba na otestovanie komunikácie
  2. Kód HDO (množina dát, pre celú bilančnú skupinu)
  3. Namerané dáta (jednotlivo)
  4. Namerané dáta formou streamingu (pre celú bilančnú skupinu)
  5. Status žiadostí o pripojenie (jednotlivo)

Po prihlásení do Distribučného portálu používateľom s administrátorskými oprávneniami je možné vytvoriť API používateľa pre využívanie API služieb. Funkcionalitu vytvorenia API používateľa nájdete v časti Správa používateľov, v záložke API služby.

Heslo pre API používateľa je možné resetovať rovnako, ako v prípade jeho vytvorenia, v Distribučnom portáli, po prihlásení sa používateľom s administrátorskými oprávneniami, v časti Správa používateľov, v záložke API služby.

Služba poskytuje dáta o aktuálne platných kódoch HDO (Hromadné diaľkové ovládanie), ktoré sú pridelené konkrétnym odberným miestam, reprezentovaným EIC kódom. V službe je možné zadať zoznam EIC kódov, ktoré má dodávateľ elektrickej energie aktuálne vo svojej bilančnej skupine.

Službu je možné využívať v dvoch variantoch:

  1. Kód HDO (množina dát z bilančnej skupiny dodávateľa), je variant pre volanie služby s jedným alebo viacerými vstupnými parametrami. Parametrom je v tomto prípade EIC kód odberného miesta.
  2. Kód HDO (pre celú bilančnú skupinu dodávateľa), je variant pre volanie služby s jedným vstupným parametrom, ktorým je EIC kód dodávateľa elektrickej energie, ktorý má pridelený v zmysle platnej legislatívy.

Výstupom služby je zoznam, obsahujúci EIC kód a aktuálne pridelený kód HDO. EIC kódy, ktoré nemajú pridelený kód HDO, nebudú predmetom výstupu.

Aktualizácia dát prebieha pravidelne na dennej báze.

Služba poskytuje dáta z intervalových/profilových meraní pre odberné miesta (reprezentované EIC kódom), ktoré sú, alebo boli v bilančnej skupine dodávateľa. Dodávateľom budú poskytnuté dáta pre odberné miesta podľa platnej legislatívy.

Služba ponúka možnosti spresnenia výberu nameraných dát podľa typu profilu:

 

Kód Popis typu profilu
PS_MINUS Činná dodávka so stratami
PS_PLUS Činný výkon so stratami
P_MINUS Činná dodávka
P_PLUS Činný výkon
Q1 Jalový odber pri odbere
Q1S Jalový odber pri odbere so stratami
Q2 Jalový výkon pri dodávke
Q2S Jalový výkon pri dodávke so stratami
Q3 Jalový odber pri dodávke
Q3S Jalový odber pri dodávke so stratami
Q4 Jalová dodávka pri odbere
Q4S Jalová dodávka pri odbere so stratami

V určitých situáciách sa môže vyskytnúť stav, kedy hodnoty so stratami sú identické, ako hodnoty bez strát.

Uvedenú službu je možné používať v dvoch variantoch:

  1. Namerané dáta (single), kde sú vstupnými parametrami:
    • EIC kód odberného miesta,
    • typy profilov (nepovinné, ak nie je zadaný zoznam, tak služba vráti všetky typy profilov, ktoré sa daného odberného miesta týkajú).
  2. Namerané dáta (stream, pre celú bilančnú skupinu dodávateľa), kde sú vstupnými parametrami:
    • EIC kód účastníka trhu,
    • typy profilov,
    • minimálne EIC odberného miesta,
    • limit na maximálny počet vrátených záznamov (záznam predstavuje set dát pre jeden EIC kód odberného miesta).

Výstup služby obsahuje pre každý EIC kód zoznam typov profilov a pre každý profil sadu 15-minútových nameraných hodnôt so statusom hodnoty (v zadanom intervale). EIC kódy, ktoré nedisponujú intervalovým meraním, nebudú predmetom výstupu. Dáta je možné žiadať najviac v intervale za aktuálny a ucelený predchádzajúci rok. Služba vráti iba také dáta, na aké ma dodávateľ elektrickej energie nárok v zmysle platnej legislatívy

V prípade pravidelného využívania streamovania dát môže nastať situácia, že dôjde k prerušeniu spojenia. V tomto prípade je vhodné použiť minimálne EIC kód odberného miesta, ktoré nebolo spracované, kontinuálne nadviazať na ďalšie volanie, a tým minimalizovať zaťaženie prenosových liniek a skrátiť čas poskytnutia dát na minimum.

Upozornenie

V testovacom režime je zabezpečená aktuálnosť dát D-1 po 14:00 hod. Naša spoločnosť si ako prevádzkovateľ distribučnej sústavy vyhradzuje právo na obmedzenie priepustnosti a používania služby z prevádzkových dôvodov.

Služba poskytuje dáta k žiadosti o pripojenie zadanej cez Distribučný portál prihláseným používateľom, ktorí sú oprávneným používateľom za dodávateľa. Vstupom do služby je identifikátor online žiadosti.

Služba poskytuje údaje:

  • číslo žiadosti podanej cez Distribučný portál,
  • EIC kód, ktorého sa daná žiadosť týka (ak EIC ešte nebol pridelený, tak vráti prázdnu hodnotu),
  • číslo obchodného partnera ZSD,
  • dátum podania žiadosti,
  • druh žiadosti,
  • dátum stornovania žiadosti,
  • chronológiu stavov žiadosti.

Položka v chronológii stavov žiadosti bude obsahovať:

  • kód kroku,
  • názov kroku,
  • stav kroku,
  • dátum zmeny kroku,
  • poradie kroku.

Každý krok musí obsahovať jeho uvedený stav, ktorý môže byť:

  • Nerelevantný (NOT_RELEVANT),
  • Zrealizovaný (REALIZED),
  • Stornovaný (CANCELED),
  • Nezrealizovaný (NOT_REALIZED).

Upozornenie

Tieto služby sú momentálne prevádzkované v testovacom režime a naša spoločnosť si vyhradzuje právo na obmedzenie ich dostupnosti a kvality dát.