Dokumentace k API skloňování jmen
Adresa, kterou máte k dispozici:
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=AdelaidaPovinné parametry klic, pad a jmeno
| klic | kombinace číslic a písmen, kterou se odlišují dotazy jednotlivých zákazníků.
|
| pad | číslo označující pád jména, který chcete získat:
|
| jmeno | latinkou (nebo ukrajinskou cyrilicí) psané celé občanské jméno v 1. pádu, jehož tvar chcete získat. Může obsahovat více jmen oddělených svislicí „|“, v takovém případě systém vrátí výčet zpracovaných jmen oddělených týmž znakem. Maximální délka tohoto parametru je 8000 znaků – odpovídá cca 300 kombinacím křestních jmen, příjmení a titulů z českého prostředí (včetně diakritiky). Zadáním celého jména získáte přesnější výsledky než při vložení samotného příjmení nebo křestního jména. |
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Adelaida|Tomáš Novák|Firma, s r. o.
Vrátí:
Vrátí:
paní Adelaido|pane Nováku|váženíNepovinné parametry
Nepovinné parametry je možné libovolně kombinovat. Nadbytečně uvedené parametry systém ignoruje. Například u mužských jmen nezáleží na tom, zda URL obsahuje parametr osloveni-zeny.
| format | s hodnotou json vrátí výsledky ve formátu JSON. V opačném případě systém vrátí text/html.
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Adelaida|Tomáš Novák&format=json
Vrátí: [{"dotaz":"Adelaida","odpoved":"paní Adelaido"},{"dotaz":"Tomáš Novák","odpoved":"pane Nováku"}] | |||||||||||||||||||||||||||
| osloveni-zeny | fráze, která bude použita před jménem v případě, že se jedná o ženu. Výchozí hodnotou je paní.
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Adelaida&osloveni-zeny=Vážená paní
Vrátí: Vážená paní Adelaido
| |||||||||||||||||||||||||||
| osloveni-muze | bude použito na vytvoření tvaru jména muže. Výchozí hodnotou je pane. | |||||||||||||||||||||||||||
| osloveni-firmy | zadaný řetezec systém vrátí v případě, kdy zjistí, že zadané jméno nenáleží člověku, ale právnické osobě. Využívá se pouze při vracení 5. pádu, v ostatních systém vrací chybu 8.
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Firma, s r. o.&osloveni-firmy=Vážení partneři
Vrátí: Vážení partneři
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Firma, s r. o.&osloveni-firmy=ano Vrátí: Vážený pane Firmo | |||||||||||||||||||||||||||
| pohlavi | znáte-li pohlaví nositele jména, uvedením tohoto parametru s hodnotou 1 (ženské jméno) či 2 (mužské jméno) můžete zpřesnit výsledek u obourodých jmen. Výchozí hodnotou je 0 – pohlaví neznámé. | |||||||||||||||||||||||||||
| pouzit-krestni | určuje, zda ve výstupu budou obsažena křestní jména.
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Tomáš Novák&pouzit-krestni=ano
Vrátí: pane Tomáši Nováku
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Tomáš Novák&pouzit-krestni=Tomáš Vrátí: pane Tomáši Nováku | |||||||||||||||||||||||||||
| pouzit-osloveni | určuje, zda ve výstupu budou použita úvodní „pane“ / „paní“ či obsah parametrů osloveni-zeny a osloveni-muze.
| |||||||||||||||||||||||||||
| pouzit-prijmeni | určuje, zda ve výstupu budou obsažena příjmení.
| |||||||||||||||||||||||||||
| pouzit-titul | určuje, zda ve výstupu budou použity případné akademické tituly a vojenské hodnosti.
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Ing. Josef Novák&pouzit-titul=bez-jmena
Vrátí: pane inženýre
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Ing. Josef Novák&pouzit-titul=ano Vrátí: pane inženýre Nováku
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Ing. Josef Novák&pouzit-titul=ne Vrátí: pane Nováku
https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Ing. Josef Novák&pouzit-titul=zkratka Vrátí: pane Ing. Nováku | |||||||||||||||||||||||||||
| privlastnovaci-rod | Beta verze vrátí přídavné jméno přivlastňovací v příslušném rodu, čísle a životnosti. Automaticky jsou ignorovány parametry pouzit-osloveni, osloveni-muze a osloveni-zeny. Výchozí hodnotou je (prázdný řetězec). Možné hodnoty:
| |||||||||||||||||||||||||||
| Překonané (deprecated), použijte raději parametry pouzit-krestni, pouzit-osloveni, pouzit-prijmeni a pouzit-titul. |
Chyby:
V případě, že při ohýbání jména dojde k problémům, vrátí server pouze číslo chyby.| 1 | Chybný nebo neuvedený klic. | ||||||||||||
| V této verzi se nepoužívá. | 3 | Byl vyčerpán kredit. Nebo jeho zůstatek neumožňuje zpracování celého zaslaného seznamu jmen. | 4 | Parametr pad neobsahuje očekávanou hodnotu. | 5 | Parametr jmeno neobsahuje hodnotu. | 6 | Chybí některý z povinných parametrů (klic, pad a jmeno). | 7 | Řetězec zadaný v parametru jmeno s největší pravděpodobností není jménem ani fyzické, ani právnické osoby. (Obsahuje například číslice či zavináč.)
| 8 | Řetězec zadaný v parametru jmeno je jménem právnické osoby. | V případě, že je požadován 5. pád podstatného jména, systém místo této chyby vrátí hodnotu nepovinného parametru osloveni-firmy, jehož výchozí hodnotou je vážení. |
Zjištění technických parametrů účtu:
https://www.sklonovani-jmen.cz/api?klic=klic&informace=1Tento tvar adresy slouží ke zjišťování údajů o účtu. Její použití je samozřejmě bezplatné.
Použité povinné parametry:
| klic | kombinace číslic a písmen, kterou se odlišují dotazy jednotlivých zákazníků. Stejný, jako se používá ke skloňování jmen. |
| informace | kód určující typ získané informace. Může obsahovat tyto hodnoty:
|
Nepovinný parametr
| format | s hodnotou json vrátí výsledky ve formátu JSON. V opačném případě systém vrátí text/html. S tímto parametrem jsou vráceny všechny hodnoty bez ohledu na hodnotu parametru informace.
https://www.sklonovani-jmen.cz/api?klic=klic&informace=1&format=json
Vrátí: [{"kredit-zbyvajici-dny":365,"kredit":150,"denni-kredit":10}] |
Zpracování seznamu jmen
Přes API lze zaslat více jmen oddělených svislicí „|“. Celkový počet takto zaslaných jmen nesmí překročit předplacený kredit.
Dávkové zpracování seznamu jmen
Alternativně můžete využít formulář pro jednorázové zpracování seznamu, který není součástí API. Rozsah seznamu nesmí překročit výši předplaceného kreditu.