Batch API (admin)¶
Pro partnerská řešení, která spravují instance AbraFlexi (zejména v cloudu), admin Batch API přijme seznam operací nad uživateli a firmami a vykoná je atomicky na jednom serveru. Odlišné od Dávkové operace a transakce (hromadné úpravy uvnitř databáze firmy). Zdroj: podpora.flexibee.eu.
Warning
Stav API je zatím beta. Před produkčním použitím důkladně ověřte na testovacím prostředí. Operace jsou idempotentní — opakování přeskočí již provedenou práci.
Endpoint¶
PUT https://server:7000/admin/batch
Content-Type: application/xml
Verzeované cesty /v2/admin/batch a /v3/admin/batch přijímají i
běžně přihlášeného uživatele s právy manageAll a licenseMgmt
(omezeno na jeho licenční skupiny). Neverzeovaná /admin/batch zůstává
vyhrazena serverové autorizaci.
Autorizace¶
Způsob |
Kde |
|---|---|
Serverové jméno/heslo |
Jen vlastní instalace — |
Klientský certifikát |
Cloud (HTTPS port 7000); SHA1 fingerprint u podpory. |
Přihlášený administrátor |
Jen verzeované cesty; cizí licenční skupina → |
Impersonace po serverové autorizaci: hlavička
X-FlexiBee-Authorization: username.
Ukázka dávky¶
<?xml version="1.0"?>
<flexibee-batch id="abc-123">
<user>
<username>anna.mlada</username>
<password hash="sha256" salt="xyz987">af123bd35</password>
<email>anna.mlada@firma.cz</email>
<givenName>Anna</givenName>
<familyName>Mladá</familyName>
<permissions>
<manageAll>true</manageAll>
<createCompany>true</createCompany>
<deleteCompany>true</deleteCompany>
<createUser>false</createUser>
<changePassword>false</changePassword>
<grantPermission>true</grantPermission>
<licenseManagement>false</licenseManagement>
</permissions>
<defaultRole>UZIVATEL</defaultRole>
</user>
<company action="create-update">
<id>moje_firma_s_r_o_</id>
<name>Moje Firma s.r.o.</name>
<country>CZ</country>
<regNo>123</regNo>
<vatId>CZ123</vatId>
<type>PODNIKATELE</type>
<adminUser>anna.mlada</adminUser>
</company>
<company action="delete">
<id>demo_a_s_</id>
</company>
</flexibee-batch>
Typické akce user / company: create-update (výchozí),
delete, blokace (blocked), skrytí/zobrazení firmy (show),
změny rolí přes defaultRole / access.
Standardní role: ADMIN, SUPERUZIVATEL, MZDOVYUCETNI,
UCETNI, OBCHODNIK, SKLADNIK, SKLADNIKSPOKLADNOU,
UZIVATEL, JENCIST, ZABLOKOVAN.
Organizační type: PODNIKATELE, PODNIKATELE+PU,
PODNIKATELE+DE, ROZPOCTOVE, NEZISKOVE, PODNIKATELIA (SK).
Hash hesel: sha256 (výchozí), sha512, sha1, md5,
pbkdf2. Digest z salt + ":" + heslo, lowercase hex; uloženo jako
hash:salt:digest.
Odpověď¶
HTTP 200 pro celou dávku neznamená, že všechny položky uspěly.
Každý <entry> má vlastní stav (CREATED, SKIPPED, FAILED,
…) — vždy je kontrolujte.