Preskoči na glavno vsebino

Aktualizácia firiem z ARES cez API

Ako vykonať službu „Aktualizovať všetko“ a „Aktualizovať z internetu“ cez API?

Avtor: Petr Pech

V desktopovej aplikácii aj vo webovom rozhraní existuje služba, ktorá u firmy v adresári aktualizuje údaje z ARESu. Funkcia v REST API má rovnaké správanie ako v desktope — aktualizuje IČ DPH a bankové spojenie, adresu firmy ani nové firmy nezakladá.


Zostavenie URL

Služba je dostupná na adrese /adresar/aktualizovat-vse a volá sa metódou GET:

GET https://demo.flexibee.eu/c/demo/adresar/aktualizovat-vse.json

Volanie je možné zúžiť filtrom v okrúhlych zátvorkách:

GET https://demo.flexibee.eu/c/demo/adresar/(id eq 720)/aktualizovat-vse.json
GET https://demo.flexibee.eu/c/demo/adresar/(kod = 'ABRA')/aktualizovat-vse.json

⚠️ Iná HTTP metóda ako GET vracia 405 Method Not Allowed.


Príklady použitia

Aktualizovať všetko

Volanie bez filtra je obdobou používateľskej služby Aktualizovať všetko a vykoná aktualizáciu nad kompletným adresárom, ako je v ABRA Flexi evidovaný.

GET https://demo.flexibee.eu/c/demo/adresar/aktualizovat-vse.json

🚨 Bez filtra služba prechádza celý adresár, takže pri väčších databázach beží dlho a mení mnoho firiem naraz. V produkcii ju preto spúšťajte s filtrom, alebo mimo pracovnej doby.

Aktualizovať konkrétnu firmu

Volanie s filtrom je obdobou používateľskej služby Aktualizovať z internetu — aktualizuje len vyfiltrované adresárové záznamy, opäť ich IČ DPH a bankové spojenie. Adresa firmy sa nemení.

GET https://demo.flexibee.eu/c/demo/adresar/(kod = 'ABRA')/aktualizovat-vse.json


Výstup

Výstup obsahuje štandardné návratové hodnoty s počtom zmenených záznamov a ich ID:

{
"winstrom": {
"@version": "1.0",
"success": "true",
"stats": {
"created": "0",
"updated": "2",
"deleted": "0",
"skipped": "0",
"failed": "0"
},
"results": [
{ "id": "813" },
{ "id": "807" }
]
}
}

Filter, ktorý nenájde žiadnu firmu, vracia tiež 200 a success true, ale s updated rovným nule a prázdnym results. Skutočný počet aktualizácií preto vždy čítajte z updated.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?