eFaktury.sk API

Základné informácie

API eFaktury.sk Vám umožňuje prístup k Vašim dátam ako aj možnosť vytvárať a spravovať faktúry priamo z Vašej vlastnej aplikácie. Naše API používa XML, REST a prenos dát prebieha v zabezpečenej forme prostredníctvom SSL protokolu (HTTPS).

Autentifikácia

Autentifikácia je možná jedine prostredníctvom HTTP Basic Authentication. Prihlasovacím menom je Váš Access Token a heslo nie je potrebné. Ak Váš klient vyžaduje zadanie hesla, best practice je použiť "X". Access Token môžete nájsť po prihlásení do aplikácie v časti "Môj účet". Prihlasovacie údaje musia byť súčasťou každej API požiadavky.

Príklad využitia Access Tokenu pre prihlásenie: 

curl -u TOKEN:X https://www.efaktury.sk/faktury.xml

Volanie API

Každá požiadavka musia oproti nášmu API musí okrem autentifikačného tokenu zahŕňať aj hlavičky "Content-Type" a "Accept" nastavené na hodnotu "application/xml".

Príklad využitia povinných hlavičiek: 

curl -H "Content-Type: application/xml" \
     -H "Accept: application/xml" \
     https://www.efaktury.sk/faktury.xml

HTTP kódy odpovedí

Súčasťou každej odpovede tzv. HTTP status kódy. Zoznam HTTP status kódov môžete nájsť na stránke W3C. Lepší prehľad však nájdete na wikipédii. Najčastejšie však môžete očakávať jeden z nasledujúcich kódov:


200 OK Požiadavka bola úspešná
201 Created Nový záznam bol vytvorený
401 Unauthorized Autentifikačný token nebol súčasťou požiadavky alebo bol nesprávny
404 Not Found Požadovaný záznam nebol nájdený
422 Unprocessable Entity Požiadavka bola vytvorená správne ale nepodarilo sa ju uskutočniť. Napr. SQL príkaz nebol vykonaný, záznam nebol vymazaný, záznam sa nepodarilo vytvoriť a pod.
500 Internal Server Error Vnútorná chyba servera