Fakturoid API a integrace

Potřebujete propojit svůj web, e-shop či aplikaci s Fakturoidem? Mrkněte na to, kolik API požadavků máte k dispozici, jak se požadavky účtují a jak fungují API klíče.

Obsah článku

Co jsou to API požadavky?

Aplikace na webu mezi sebou komunikují pomocí rozhraní API. Můžete si přes něj k Fakturoidu pripojit e-shop nebo jinou aplikaci, která přes API bude moct pracovat s vaším Fakturoidím účtem - vytvořit fakturu, aktualizovat kontakt a tak podobně.

Jak se API požadavky počítají?

Pro vystavení faktury je typicky potřeba jeden požadavek na vytvoření kontaktu, druhý na vytvoření faktury a třetí na odeslání faktury. Další požadavek může být například na stažení seznamu faktur (každá stránka se počítá zvlášť, pokud jich máte více) nebo stažení údajů o konkrétní faktuře.

Limity v jednotlivých tarifech

API je dostupné pro každý účet v každém tarifu. Rozdíl spočívá v počtu dostupných API požadavků:

  • tarify Zdarma a Základ - 3 000 API požadavků / měsíc
  • tarif Komplet - 20 000 API požadavků / měsíc

API požadavky ve starších tarifech:

  • tarify Sólo+ a Sólo - 3 000 API požadavků / měsíc
  • tarif Firma - 50 000 API požadavků / měsíc

Překročení limitu API požadavků

Limity API požadavků platí vždy pro kalendářní měsíc. Při překročení v rámci měsíce API nevypínáme, necháváme jej běžet dál. Po skončení měsíce se vám ozveme s informací o překročení limitu a nabídneme vám možná řešení.

Pokud se jednalo o jednorázové překročení, není potřeba nic dělat, nebudete muset přecházet na vyšší tarif, ani nic doplácet.

Dochází-li k překračování opakovaně, bude potřeba přejít na tarif Komplet (v případě tarifů Zdarma, Základ, Sólo a Sólo+).

Pokud už máte tarif Komplet nebo Firma, automaticky se vystaví faktura za nadlimitní využití API. Každých 10 000 API požadavků nad rámec tarifu dokoupíte za 110 Kč bez DPH.

Více účtů pod jedním uživatelem

Uživatelům s více účty se API požadavky počítají pro každý účet zvlášť.

Testovací účet

Nabízíme také bezplatné testovací účty. Další podrobnosti najdete v informacích pro vývojáře.

Jak zjistím, kolik požadavků bylo vyčerpáno?

Počet požadavků, které jste provedli za aktuální měsíc, zjistíte v Nastavení → Napojení na jiné aplikace.

API klíč

Pokud za aktuální kalendářní měsíc vyčerpáte více než 75 % z limitu API požadavků pro váš tarif, zobrazíme upozornění na Přehledu.

Počet vyčerpaných API požadavků se aktualizuje zhruba jednou za hodinu.

API v2 klíč

K úspěšnému propojení potřebujete API klíč. Je vázaný na uživatele a najdete ho v Nastavení → Uživatelský účet.

API klíč

API v3 přístupové údaje

Oproti API v2 probíhá autorizace přes OAuth 2. Dokumentace k API v3 je dostupná na našem webu.

Z pohledu uživatele

Přímo v integraci budete přesměrováni do Fakturoidu (a ověříte se emailem a heslem). Žádný token ani kód nikam jako uživatel nezadáváte a integrující aplikace nemusí a nemůže znát vaše heslo do Fakturoidu.

Vývoj vlastní integrace

V sekci Nastavení → Uživatelský účet najdete Client IDClient Secret.

Client ID a Client secret v nastavení uživatelského účtu

Vývoj integrace pro další uživatele

Pokud vyvíjíte multitenantní aplikaci (třeba plugin pro napojení e-shopu, který chcete prodávat veřejně jako doplněk daného eshopu), je potřeba vytvořit novou integraci v Nastavení → Napojení na jiné aplikace → OAuth 2 pro tvůrce aplikací.

Vytvoří se speciální Client ID a Client Secret pouze pro tuto integraci.

Nastavení pro multitenantní integraci

Pozor na sloučení přihlášení

Rozhodli jste se založit si další fakturoidí účet a sloučit si přihlášení? Pak je potřeba pohlídat, který z API klíčů byl použit pro nastavení propojení.

Jestliže jste si propojení nastavili na uživatele, ke kterému slučujete druhý účet (tudíž ten původní nezaniká), není potřeba v nastavení propojení nic měnit.

Pokud máte propojení nastavené na uživatele, kterého převádíte a tudíž zanikne, původní API klíč také zaniká a je potřeba jej v nastavení integrace změnit.

Mohlo by vás zajímat

Prohledat Podporu

Nenašli jste? Napište nám email nebo využijte povídátko v pravém dolním rohu.