Chytry odbě ratěl API v0.3 Obsah Kalkulačka... 2 Povinné parametry... 2 Nepovinné parametry... 2 Výpočty při neznámých hodnotách... 2 Výpočty s přesnými hodnotami.... 3 Elektřina... 3 Plyn... 3 Návratové XML... 3 Chybové XML... 4 Objednávky... 4 Povinné parametry - obecné... 4 Povinné parametry dle komodity... 5 Elektřina... 5 Plyn... 5 Nepovinné parametry... 5 Návratové XML... 6 Chybové XML... 6
2 Kalkulačka K dispozici jsou dva druhy výpočtu: elektřiny a plynu. Výpočet cen probíhá zavoláním URL adresy http://www.chytryodberatel.cz/api/c/?partner=string&komodita=string&kraj=string&typ_pouziti=str ing&sazba=string&vt=string&nt=string&plyn=string Povinné parametry partner = identifikátor partnera získaný při registraci komodita = identifikátor komodity 1 elektřina 2 plyn kraj = identifikátor kraje dle číselníku 1 Moravskoslezský 2 Olomoucký 3 Zlínský 4 Jihomoravský 5 Vysočina 6 Pardubický 7 Královehradecký 8 Liberecký 9 Ústecký 10 Karlovarský 11 Plzeňský 12 Středočeský 13 Jihočeský 14 Praha Nepovinné parametry (použití dle typu požadovaného výpočtu) Výpočty při neznámých hodnotách (zákazník nezná svou spotřebu). Typy jsou shodné pro obě komodity. typ_pouziti = identifikátor typu použití dle číselníku. Shodný pro elektřinu i plyn. 1 malý byt/vařím (1-2 osoby) 2 větší byt nebo dům/ohřívám vodu (2-4 osoby) 3 Rodina, dům vytápěný bojlerem/topím v bytě (4 a více osob) 4 Rodina, dům vytápěný přímotopem/topím v domě (4 a více osob)
3 Výpočty s přesnými hodnotami. Liší se dle komodity. Elektřina sazba = sazba tarifu elektřiny, dle povolených hodnot. D01d D02d D25d D26d D35d D45d D55d D56d D61d vt = spotřeba VT (vysoký tarif). Hodnota v kwh. nt = potřeba NT (nízký tarif). Hodnota v kwh. - pro sazby D01d a D02d hodnota 0. Plyn plyn = spotřeba plynu v MWh Návratové XML XML s výsledky vrací dvě hodnoty stavu (status). ok vše proběhlo v pořádku, vráceno XML s daty error validace volaných hodnot zjistila chybu. Obsahem XML je výpis zjištěných chyb <choresults> <status>ok</status> <item> <dodavatel_id>string</dodavatel_id> <dodavatel_nazev>string</dodavatel_nazev> <dodavatel_logo>string</dodavatel_logo> <tarif_nazev>string</tarif_nazev> <tarif_id>string</tarif_id> <cena_s_dph>string</cena_s_dph>
4 <uspora>string</uspora> </item> </choresults> Chybové XML <choresults> <status>error</status> <item> <kraj>zvolte kraj</kraj> <spotreba>uveďte spotřebu</spotreba> <sazba>string</sazba> </item> </choresults> Objednávky Veškeré objednávky jsou zasílány metodou POST na adresu http://www.chytryodberatel.cz/api/o/ Povinné parametry - obecné partner = identifikátor partnera získaný při registraci komodita = identifikátor komodity dle číselníku 1 elektřina 2 plyn kraj = identifikátor kraje dle číselníku 1 Moravskoslezský 2 Olomoucký 3 Zlínský 4 Jihomoravský 5 Vysočina 6 Pardubický 7 Královehradecký 8 Liberecký 9 Ústecký 10 Karlovarský 11 Plzeňský 12 Středočeský 13 Jihočeský 14 Praha dodavatel = identifikátor dodavatele získaný z návratového XML (dodavatel_id)
5 tarif = identifikátor tarifu získaný z návratového XML (tarif_id) jmeno = jméno zákazníka prijmeni = příjmení zákazníka email = e-mailová adresa zákazníka telefon = telefon zákazníka souhlas = potvrzení souhlasu se zpracováním osobních údajů 1 souhlasí se zpracováním osobních údajů order = identifikátor akce - insert = vložení nového záznamu rp1 a rp2 = kontrolní hodnoty (obě nabývají hodnoty 1111 ) Povinné parametry dle komodity Elektřina sazba = sazba tarifu elektřiny, dle číselníku 1 - D01d 2 - D02d 3 - D25d 4 - D26d 5 - D35d 6 - D45d 7 - D55d 8 - D56d 9 - D61d vt = spotřeba VT (vysoký tarif). Hodnota v kwh. nt = potřeba NT (nízký tarif). Hodnota v kwh. - pro sazby D01d a D02d hodnota 0. Plyn plyn = spotřeba plynu v MWh Nepovinné parametry smlouva = druh smlouvy dle číselníku 1 na dobu určitou 2 na dobu neurčitou zanik = datum zániku současné smlouvy
6 Návratové XML Po vložení objednávky do systému bude navráceno XML se stavem (status) ok objednávka byla v pořádku přijata error - validace volaných hodnot zjistila chybu. Obsahem XML je výpis zjištěných chyb <choorder> <status>ok</status> </choorder> Chybové XML <choorder> <status>error</status> <item> <kraj>zvolte kraj</kraj> <spotreba>uveďte spotřebu</spotreba> <sazba>string</sazba> </item> </choorder>