Nápověda
API
V případě jakýchkoliv dotazů nás neváhejte kontaktovat. Rádi Vám s implementací klienta pomůžeme. Nábízíme také vytvoření modulu pro napojení Pohlídáme.cz na váš IS dle požadavků.
1. Základní vlastnosti API
- Je založené na protokolu HTTP.
- Je přístupné na adrese http://www.pohlidame.cz/api .
- Všechny vstupní parametry se předávají v "query části" URL.
- Výstup je v těle HTTP odpovědi.
- Každý požadavek je autentizován (proprietárním způsobem - viz níže).
- Každý požadavek je buď akce (provádí zmenu v datech uživatele), nebo dotaz (výpis dat uživatele).
- Komunikační protokol je bezestavový - každá akce má okamžitý účinek.
- Při tvorbě API jsme se drželi požadavku na jeho maximální jednoduchost. Proto některé typy požadavků tedy vracejí pouze text, jiné XML (viz dále).
- MIME typ obsahu odpovědi je uvedený v HTTP hlavičce Content-Type.
2. Autentizace
Každý požadavek musí nést parametry jmeno, salt, saltHesloHash.
- jmeno je uživatelské jméno účtu, se kterým chcete pracovat.
- salt je jakýkoliv náhodně vygenerovaný řetězec. Doporučujeme se držet délky do 10 znaků. Pro každý požadavek je nutné vygenerovat novou hodnotu.
- saltHesloHash je MD5 hash sestavený podle následujícího "postupu":
saltHesloHash = md5( <salt> + md5(<heslo>) )
kde <heslo> je heslo k účtu danému parametrem jmeno.
3. Typy požadavků - akce a dotazy
Akce se určuje parametrem akce, tj. např. http://www.pohlidame.cz/api?akce=pridejVzor&...
3.1 pridejVzor (akce, vrací XML)
Popis: Přidá uživateli vzor. Pohlídáme.cz automaticky prohledá existující osoby v insolvenčním rejstříku, a spisy případných odpovídajících osob přidá mezi sledované. Takto nalezené osoby budou vypsané v odpovědi akce.
Parametry:
- jmeno - jméno hlídané fyzické osoby nebo firmy.
- ic - identifikační číslo osoby.
- rc - rodné číslo osoby.
Příklad: vložení vzoru s rodným číslem 6857311153.
Dotaz
http://www.pohlidame.cz/api?uziv=vas@mail.cz&salt=abc&saltHesloHash=...&akce=pridejVzor&rc=6857311153
Odpověd
3.2 odeberVzor (akce, vrací text)
Popis: Přidá uživateli vzor. Po odebrání již nebudou zachytávány události osob nově přidaných do insolvenčního rejstříku. Nadále však budou zachytávány události osob automaticky nalezených při vkládání vzoru a osob zapsaných do insolvenčního rejstříku po přidání vzoru.
Parametry:
- id - identifikátor vzoru k odebrání. Identifikátory je možné získat z výpisu dotazu vypisVzory.
Příklad: odebere vzor s ID 1688
Dotaz
http://www.pohlidame.cz/api?uziv=vas@mail.cz&salt=abc&saltHesloHash=...&akce=odeberVzor&id=1688
Odpověd
3.3 vypisVzory (dotaz, vrací XML)
Popis: Vypíše vzory a sledované osoby daného uživatele. Ukázkový výstup viz níže.
Parametry:
- žádné
Příklad:
Dotaz
http://www.pohlidame.cz/api?uziv=vas@mail.cz&salt=abc&saltHesloHash=...&akce=vypisVzory
Odpověd
3.4 vyhledejOsobyIsir (dotaz, vrací XML)
Popis: Vyhledá osoby obsahující zadaný text - ať již rodné číslo, identifikační číslo nebo jméno.
Parametry:
- obsahuje - hledaný text. Musí obsahovat minimálně 3 alfanumerické znaky. Např. "ver" najde osoby "Veronika Machová", "Big Advertisment sro." a podobně. "640220/1234" najde osobu "František Dlužník".
Příklad: vyhledání: "Petra"
Dotaz
http://www.pohlidame.cz/api?uziv=vas@mail.cz&salt=abc&saltHesloHash=...&akce=vyhledejOsobyIsir&obsahuje=Petra
Odpověd
SMS notifikace
SMS email je negarantovaná služba, která Vám může pomoci být rychleji informováni o změnách u Vámi hlídaných subjektů než v případě použití emailu.
SMS na Telefonica O2
V síti Telefonica O2 má každý mobil automaticky přidělenou e-mailovou adresu ve tvaru 00420xxxyyyyyy@sms.cz.o2.com, kde xxx je předvolba a yyyyyy vlastní číslo mobilu. V případě, že chcete využít zasílání notifikace na Váš mobil v této síti, stačí doplnit Vaše číslo v předem uvedeném formátu.
Příklad: Mobil s číslem 0602/123456 má e-mailovou adresu 00420602123456@sms.cz.o2.com
Pro bližší informace kontaktujte bezplatnou linku Vašeho operátora na čísle *11.
SMS na T-Mobile
Pro zasílání SMS notifikaci u T-Mobile je nutné mít tento SMS email zřízen u Vašeho operátora. Výsledný email bude mít tvar jmeno@t-email.cz, případně jmeno@sms.paegas.cz nebo jmeno@click.cz.
Pro bližší informace kontaktujte bezplatnou linku Vašeho operátora na čísle 4603.
SMS na Vodafone
Stejně jako v případě operátora T-Mobile je nutné si nastavit SMS email u operátora. Výsledný email bude mít tvar jmeno@vodafonemail.cz.
Pro bližší informace kontaktujte bezplatnou linku Vašeho operátora na čísle *77, nebo *077.
Přidání vyhledávacího modulu do Vašeho prohlížeče
Vyhledávejte v insolvenčním rejstříku přímo z Vašeho prohlížeče! V prohlížečích Internet Explorer 7 a vyšší a Firefox 1.5 a vyšší si můžete přidat modul pro vyhledávání v Insolvenčním Rejstříku. Samotné přidání provedete jednodušše v pravém horním rohu Vašeho prohlížeče v nabídce dostupných vyhledávacích modulů.