API pre vývojárov

REST API nad tými istými údajmi, s ktorými pracuje aplikácia. Faktúry, odberatelia, sklad a webhooky.

API je určené na prepojenie s e-shopom, s vlastným systémom alebo s nástrojom, ktorý PLEVIX nemá. Nie je to náhrada aplikácie — autentifikácia je tokenom účtu a všetko, čo cez API urobíte, sa objaví v aplikácii a naopak.

Ako začať

1. Vytvoríte token. V nastaveniach účtu, s právami, ktoré potrebujete. Token má rozsah — čítanie, zápis alebo oboje, a len pre vybrané nástroje.
2. Pošlete požiadavku. Token v hlavičke Authorization, telo v JSON. Odpoveď je vždy JSON s poľom ok.
3. Nastavíte webhook. Adresu, na ktorú PLEVIX pošle oznámenie, keď sa niečo zmení — nemusíte sa opakovane pýtať.

Čo sa dá cez API

Faktúry

Vystaviť faktúru, načítať zoznam, zistiť stav úhrady, stiahnuť PDF alebo XML. Číselný rad sa vedie rovnako ako v aplikácii — API nedovolí číslo preskočiť.

Odberatelia

Pridať, upraviť, nájsť podľa IČO. Je to tá istá databáza, akú používa CRM aj faktúry, takže odberateľ pridaný cez API je hneď dostupný v aplikácii.

Sklad

Stav zásob, príjemky a výdajky. Užitočné pri e-shope, ktorý má vlastný katalóg a potrebuje len odpísať tovar pri odoslaní.

Doklady

Nahrať prijatý doklad na vyťaženie a načítať výsledok. Vyťaženie je asynchrónne — výsledok príde webhookom alebo sa naň dopýtate.

Webhooky

Oznámenie pri vystavení faktúry, prijatí úhrady, zmene stavu objednávky alebo dokončení vyťaženia dokladu. Podpísané tajným kľúčom, aby ste si overili, že prišlo od nás.

Pravidlá, ktoré treba poznať

Časté otázky

Je API súčasťou predplatného?

Áno, pri platenom predplatnom. Bezplatná úroveň API nemá. Za požiadavky sa neplatí zvlášť, platí len limit na ich počet.

Existuje testovacie prostredie?

Áno. Token sa dá vytvoriť pre testovaciu firmu, kde si môžete vystavovať doklady bez toho, aby vstúpili do vášho účtovníctva.

Prepojí sa to s mojím e-shopom?

Ak má váš e-shop možnosť volať externé API, áno. Hotové moduly pre konkrétne platformy sú v pláne vývoja.

Čo keď potrebujem niečo, čo API nemá?

Napíšte na support@plevixbusiness.com s tým, čo potrebujete a prečo. API sa rozširuje podľa toho, čo zákazníci naozaj používajú.

Ako je to s e-fakturáciou od 2027?

XML v štruktúrovanom formáte viete stiahnuť už dnes. Doručovanie cez Peppol je v príprave — stav je v pláne vývoja.

Súvisiace: import zo súboru · Faktúry · Eshop · Sklady · plán vývoja