Pro přístup k datům přes REST API Flexi je nutné znát identifikátor firmy. Ten obvykle vychází z názvu firmy, není to však podmínkou. Identifikátor musí být unikátní pro firmu na daném serveru.

Povolené znaky identifikátoru jsou malá písmena, číslice a podtržítko — ostatní znaky v názvu firmy jsou nahrazeny právě podtržítkem. Pokud již existuje firma se stejným názvem, doplní se identifikátor o pořadové číslo.

Kdy se identifikátor mění

Identifikátor zůstává neměnný, pokud firmu přejmenujete.
Pokud firmu zálohujete a obnovíte ve stejném datovém zdroji, dostane jiný identifikátor.
Pokud firmu smažete a znovu vytvoříte, může být pod stejným identifikátorem jiná firma.

⚠️ Identifikátor proto nepoužívejte jako trvalý klíč firmy ve své integraci. Pokud si jej ukládáte, po obnovení firmy ze zálohy jej ověřte znovu.

Jak identifikátor zjistit

Existují dvě možnosti:

1) Z webového rozhraní

Přihlásíme se do webového rozhraní přes internetový prohlížeč a identifikátor firmy zjistíme ihned v adresním řádku. V tomto případě je identifikátor demo_neziskova:

https://demo.flexibee.eu/c/demo_neziskova

2) Přes REST API

Metodou GET na URL server:port/c.xml, alternativně /c.json:

GET https://demo.flexibee.eu:5434/c.xml?limit=0

Tímto dotazem získáme kompletní seznam firem v XML/JSON. V poli dbNazev zjistíme identifikátor, v poli nazev uživatelsky čitelný název firmy, jak jej vidíme v aplikaci. Ukázka výstupu:

<companies> 
  <company> 
    <createDt>2020-03-05T12:51:18.757+01:00</createDt> 
    <dbNazev>demo</dbNazev> 
    <id>-2</id> 
    <licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup> 
    <nazev>Demo firma</nazev> 
    <show>true</show> 
    <stavEnum>ESTABLISHED</stavEnum> 
    <watchingChanges>true</watchingChanges> 
  </company> 
  <company> 
    <createDt>2012-09-10T13:24:49.765+02:00</createDt> 
    <dbNazev>demo_de</dbNazev> 
    <id>-2</id> 
    <licenseGroup>39fa897328d1e6a55ab199f1410015d2</licenseGroup> 
    <nazev>Já Živnostník</nazev> 
    <show>true</show> 
    <stavEnum>ESTABLISHED</stavEnum> 
    <watchingChanges>true</watchingChanges> 
  </company> 
</companies>

Pole ve výstupu

`dbNazev`	Identifikátor firmy — hodnota, kterou uvádíte v URL za `/c/`
`nazev`	Uživatelsky čitelný název firmy, jak jej vidíme v aplikaci
`createDt`	Datum vytvoření firmy
`show`	Zda je firma přístupná
`stavEnum`	Stav firmy: `ESTABLISHING` — zakládání, `ESTABLISHED` — aktivní, `MAINTENANCE` — údržba
`watchingChanges`	Zda je povoleno sledování změn
`licenseGroup`	Identifikátor licenční grupy, do které firma patří

ℹ️ Bez parametru limit je výstup stránkovaný jako u ostatních evidencí. Hodnota ?limit=0 vrátí všechny firmy najednou.

Související

Související články

Identifikátor firmy (ID firmy) a seznam založených firem pomocí API