Skratka API z anglického Application Programming Interface je rozhranie pre programovanie aplikácií. Môžeme všeobecne povedať, že ide o akúsi zbierku pravidiel, postupov čí funkcií, pomocou ktorých sa dajú prepojiť dva nezávislé systémy. V tomto prípade ide o prepojenie Faktúr online, napríklad s Vašim eshopom alebo webom. Výsledkom bude vytvorenie dokumentu faktúry vo Faktúrach online na základe dát pochádzajúcich z vášho eshopu.
Faktúry online API ľudskou rečou
Predstavte si dve vlakové stanice prepojené železničnou traťou. Zo stanice A pravidelne vyráža nákladný vlak, ktorý vezie dáta do stanice B. Tam sa náklad spracuje a vlak sa následne vracia späť s informáciou o výsledku. Presne takto funguje aj API Faktúr online.
Vaša aplikácia, napríklad e-shop, predstavuje stanicu A. Faktúry online sú stanica B a vlak spolu s koľajnicami predstavuje samotné API. váš systém odošle požiadavku s dátami, ktoré potrebujete spracovať. Faktúry online tieto dáta prijmú, spracujú a okamžite pošlú späť odpoveď s výsledkom. Všetko prebieha automaticky, bez manuálnych zásahov.
Výsledkom je úspora času, menej chýb a plynulý chod procesov. Faktúry sa môžu vytvárať, odosielať alebo spracovávať na pozadí presne v momente, keď ich potrebujete.
Stačí jediné. Napojiť váš systém na API, teda vybudovať „koľajnice“, po ktorých budú vaše dáta bezpečne a spoľahlivo prúdiť medzi vaším systémom a Faktúrami online. Celý proces pritom riadi váš systém. On rozhoduje, kedy sa vlak pohne, aký náklad ponesie a kedy sa má vrátiť späť s výsledkom.
Ako to funguje?
V praxi ide o komunikáciu medzi dvoma servermi prostredníctvom HTTP(S) požiadaviek. Váš e-shop (klient) odošle na server Faktúr online API požiadavku (request), ktorá obsahuje potrebné dáta, najčastejšie vo formáte JSON.
Server Faktúr online požiadavku prijme, overí jej platnosť (napríklad autentifikáciu a správnosť dát), následne ju spracuje a vykoná požadovanú operáciu, napríklad vytvorenie faktúry.
Po spracovaní server odošle späť odpoveď (response), ktorá obsahuje informáciu o výsledku operácie. Odpoveď môže obsahovať napríklad identifikátor vytvoreného dokumentu, jeho stav alebo chybové hlásenie v prípade neúspechu.
Celý proces prebieha automaticky v reálnom čase a je riadený vaším systémom, ktorý rozhoduje, kedy a aké požiadavky bude odosielať.
Ako môžem Faktúry online API prepojiť so svojím eshopom?
Implementácia API do vášho e-shopu je technický zásah. Musí ju vykonať človek alebo spoločnosť, ktorá váš e-shop vytvorila, prípadne niekto, kto sa technicky vyzná v jeho fungovaní. Vo väčšine prípadov ide o úpravu zdrojového kódu e-shopu alebo inštaláciu a nastavenie príslušného modulu.
Zvyčajne ide o implementáciu na mieru, univerzálne riešenie neexistuje. Realizáciu musí zabezpečiť zodpovedná osoba alebo spoločnosť, ktorá má prístup k zdrojovému kódu alebo administrácii systému. Faktúry online nevedia API zaviesť priamo do vášho systému, implementácia je vždy na vašej strane.
Odporúčame obrátiť sa na autora vášho systému alebo na odborníka. S implementáciou vám môžu pomôcť aj externé spoločnosti, ktoré sa na tieto riešenia špecializujú, napríklad goodeshop.sk.
Čo všetko je možné cez Faktúry online API vytvoriť?
Momentálne je možné cez API vytvárať faktúry a cenové ponuky. Okrem samotného vytvorenia API umožňuje aj ich zobrazenie, stiahnutie a získanie informácie o ich stave (statuse).
Vytváranie dokumentov prebieha na základe dát, ktoré odosielate zo svojho systému. Vďaka tomu môžu byť dokumenty flexibilné a prispôsobené vašim potrebám.
Aké typy systémov môžu používať Faktúry online API?
Prakticky akékoľvek. Jedinou podmienkou je, aby bol systém pripojený na internet. Prepojenie cez API je vhodné najmä pre systémy, ktoré potrebujú automaticky vytvárať daňové doklady, ako sú faktúry alebo cenové ponuky.
Môže ísť napríklad o webové aplikácie, e-shopy, CRM systémy, predajné systémy a podobne.
Kde nájdem technický manuál k API?
Podrobný technický manuál s ukážkami zdrojových kódov nájdete na stránke Manuál pre vývojárov.
Je API Faktúr online zadarmo?
Áno, Faktúry online API môžete používať bezplatne v rámci svojho konta vo Faktúrach online. API nie je samostatne spoplatnené ani špeciálne limitované. Na jeho používanie sa vzťahujú všeobecné podmienky služby.