API a API kľúče

API umožňuje pracovať s klientskou zónou z vašich vlastných systémov, napríklad z e-shopu, rezervačného systému alebo interných nástrojov. Úplný popis všetkých volaní nájdete v dokumentácii API.

Na čo API slúži

Cez API robíte to isté ako v zóne:

• vytvárate, vystavujete a označujete faktúry ako uhradené,
• sťahujete faktúry v PDF a ISDOC,
• posielate faktúry a pripomienky e-mailom,
• spravujete odberateľov, položky a opakované faktúry,
• kontrolujete odberateľov a exportujete faktúry pre účtovníka.

API je dostupné na adrese https://vystavfakturu.sk/api/v1. Odpovede sú vo formáte JSON.

Ktoré balíky API obsahujú

API je súčasťou balíkov Štandard a eFaktúra. Ak balík firmy funkciu neobsahuje, API odpovie stavovým kódom 402. Rovnako odpovie, ak firma prejde na balík Zadarmo.

API kľúče

Kľúč vytvoríte v zóne v nastaveniach v časti API kľúče. Kľúču dáte názov, podľa ktorého ho spoznáte, napríklad „E-shop“.

• Kľúč začína na vf_ a ukážeme vám ho iba raz, hneď po vytvorení. Uložte si ho na bezpečné miesto. My ukladáme iba jeho odtlačok, preto ho neskôr nevieme zobraziť.
• Kľúč patrí jednej firme. Všetky volania s ním pracujú s údajmi tejto firmy. Pre ďalšiu firmu si vytvorte samostatný kľúč.
• Pri každom kľúči vidíte jeho začiatok a kedy bol naposledy použitý.
• Kľúč môžete kedykoľvek zrušiť. Volania s ním prestanú fungovať okamžite.

Kľúč posielajte v hlavičke každého volania:

Authorization: Bearer vf_…

Bez platného kľúča API odpovie stavovým kódom 401.

Obmedzenia

• API prijme najviac 120 volaní za minútu. Pri prekročení API odpovie stavovým kódom 429 a treba chvíľu počkať.
• Pre e-maily platí rovnaký denný limit ako v zóne: najviac 200 e-mailov za 24 hodín na firmu.

Bezpečnosť

S kľúčom môže ktokoľvek pracovať s faktúrami vašej firmy. Nedávajte ho do kódu, ktorý beží v prehliadači, a nezverejňujte ho v repozitári. Ak máte podozrenie, že kľúč unikol, zrušte ho a vytvorte nový.