Pre prístup k dátam cez REST API Flexi je potrebné poznať identifikátor firmy. Ten obvykle vychádza z názvu firmy, nie je to však podmienkou. Identifikátor musí byť unikátny pre firmu na danom serveri.

Povolené znaky identifikátora sú malé písmená, číslice a podčiarknik — ostatné znaky v názve firmy sú nahradené práve podčiarknikom. Ak už existuje firma s rovnakým názvom, doplní sa identifikátor o poradové číslo.

Kedy sa identifikátor mení

Identifikátor zostáva nemenný, ak firmu premenujete.
Ak firmu zálohujete a obnovíte v rovnakom dátovom zdroji, dostane iný identifikátor.
Ak firmu vymažete a znovu vytvoríte, môže byť pod rovnakým identifikátorom iná firma.

⚠️ Identifikátor preto nepoužívajte ako trvalý kľúč firmy vo svojej integrácii. Ak si ho ukladáte, po obnovení firmy zo zálohy ho overte znovu.

Ako identifikátor zistiť

Existujú dve možnosti:

1) Z webového rozhrania

Prihlásime sa do webového rozhrania cez internetový prehliadač a identifikátor firmy zistíme ihneď v adresnom riadku. V tomto prípade je identifikátor demo_neziskova:

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

2) Cez REST API

Metódou GET na URL server:port/c.xml, alternatívne /c.json:

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

Týmto dopytom získame kompletný zoznam firiem v XML/JSON. V poli dbNazev zistíme identifikátor, v poli nazev používateľsky čitateľný názov firmy, ako ho vidíme v aplikácii. Ukážka 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>

Polia vo výstupe

`dbNazev`	Identifikátor firmy — hodnota, ktorú uvádzate v URL za `/c/`
`nazev`	Používateľsky čitateľný názov firmy, ako ho vidíme v aplikácii
`createDt`	Dátum vytvorenia firmy
`show`	Či je firma prístupná
`stavEnum`	Stav firmy: `ESTABLISHING` — zakladanie, `ESTABLISHED` — aktívna, `MAINTENANCE` — údržba
`watchingChanges`	Či je povolené sledovanie zmien
`licenseGroup`	Identifikátor licenčnej skupiny, do ktorej firma patrí

ℹ️ Bez parametra limit je výstup stránkovaný ako pri ostatných evidenciách. Hodnota ?limit=0 vráti všetky firmy naraz.

Súvisiace

Sorodni članki

Identifikátor spoločnosti (ID spoločnosti) a zoznam vytvorených spoločností pomocou API