zapomenuté heslo

Dokumentace k API skloňování jmen

Adresa, která je Vám k dispozici:

https://www.sklonovani-jmen.cz/api?klic=klic&pad=5&jmeno=Adelaida

Použité povinné parametry:

klic: kombinace číslic a písmen, kterými se odlišují dotazy od jednotlivých zákazníků. Klíč získáte při registraci.
pad: číslo označující pád jména, který chcete získat:
  • Výchozí hodnotou je „5“ - pátý pád jména.
  • Hodnota „2“ vrátí druhý pád jména (koho, čeho). Novinka, jejíž výsledky budeme v nejbližších týdnech zlepšovat.
  • Po zadání hodnoty „0“ API vrací značku určující pohlaví nositele jména. Značka „f“ označuje ženu, „m“ muže a „mf“ API vrací v případě, že pohlaví nelze určit.
jmeno: jméno, jehož tvar chcete získat. Může obsahovat více jmen oddělených svislicí „|“, v takovém případě systém vrátí seznam 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).

Nepovinné parametry

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í“.
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ě. Výchozí hodnotou je „vážení“. Využívá se pouze při vracení 5. pádu
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 zejména u obourodých jmen. Výchozí hodnotou je „0“ – pohlaví neznámé.
tvar: čtyřciferné číslo, které umožňuje nastavit, které položky skript vrátí. Uvedení počátečních nul je nepovinné.
  • Hodnota 1 na prvním místě udává, že bude ignorováno příjmení. (Není-li jedinou součástí zadaného řetězce.) Příklad: Josef Novák bude osloven „pane Josefe“.
  • Hodnota 1 na druhém místě znamená, že budou ignorovány případné tituly. Příklad: Ing. Josef Novák bude osloven „pane Josefe Nováku“.
  • Hodnota 1 na třetím místě určuje vypuštění úvodního pane / paní. Příklad: Josef Novák bude osloven „Josefe Nováku“.
  • Hodnota 1 na čtvrtém místě způsobí vypuštění křestních jmen. Příklad: Josef Novák bude osloven „pane Nováku“.
  • Výchozí hodnotou je 0001. Obsahuje-li jméno vědecké či akademické tituly, vytvoří se pořadovaný pád z nich; přidává se úvodní „pane“ / „paní“; křestní jména se při z oslovení vypouštějí, příjmení zůstávají.

Nabízené hodnoty a příklady vrácených tvarů 5. pádu uvádí následující tabulka:

Hodnoty parametru tvar a příklady výstupu
ČísloMgr. Josef NovákJosef NovákNovákJosefJana Nováková
1pane magistřepane Novákupane Novákupane Josefepaní Nováková
2pane magistřepane Josefe Novákupane Novákupane Josefepaní Jano Nováková
11magistřeNovákuNovákuJosefeJano Nováková
12magistřeJosefe NovákuNovákuJosefeJano Nováková
101pane Novákupane Novákupane Novákupane Josefepaní Nováková
102pane Josefe Novákupane Josefe Novákupane Novákupane Josefepaní Jano Nováková
111NovákuNovákuNovákuJosefeJano Nováková
112Josefe NovákuJosefe NovákuNovákuJosefeJano Nováková
1000pane magistřepane Josefepane Novákupane Josefepaní Jano
1112JosefeJosefeNovákuJosefeJano

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ý klíč.
  • 2: V této verzi se nepoužívá.
  • 3: Byl vyčerpán denní limit. Nebo denní 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ů (klíč, 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, systém 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=1
Tento 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, kterými se odlišují dotazy od jednotlivých zákazníků. Klíč získáte při registraci.
informace: kód určující typ získané informace. Může obsahovat tyto hodnoty:
  • 1: Vrátí počet zbývajících celých dní, po které je API předplaceno. (Dnešní den není započítán.)
  • 2: Počet dotazů, které je možné během aktuálního dne ještě odeslat.
  • 3: Předplacený denní limit - počet dotazů na každý den, které můžete po dobu předplaceného období využít.

Zpracování seznamu jmen

Přes API lze zaslat více jmen oddělených svislicí „|“. Celkový denní počet takto zaslaných jmen nesmí překročit předplacený denní limit.

Dávkové zpracování seznamu jmen

Můžete využít formulář pro dávkové zpracování seznamu. Rozsah seznamu v tomto případě není omezen denním limitem, nýbrž zbývajícím kreditem – za spotřebovaný kredit se zkracuje předplacené období. Cena za zpracování položky v tomto případě odpovídá 0,01 Kč.