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í přístupové údaje pro API (Client ID a Client Secret).
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 připojit 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.
Kolik API požadavků máte 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ů:
- tarif Zdarma a Na lehko - 1 500 API požadavků / měsíc
- tarif Na každý den - 3 000 API požadavků / měsíc
- tarif Na maximum - 20 000 API požadavků / měsíc
Co se stane, když překročíte limit 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í (max 15 000 API požadavků), nemusíte nic dělat, nebudete muset přecházet na vyšší tarif, ani nic doplácet.
Dochází-li k překračování opakovaně, doporučíme přejít na tarif Na každý den (do 3 000 API požadavků / měsíc) nebo Na maximum (nad 3 000 API požadavků / měsíc).
Pokud už máte tarif Na maximum, automaticky se vystaví faktura za nadlimitní využití API. Každých 10 000 API požadavků nad rámec tarifu dokoupíte za 199 Kč bez DPH.
Jak se počítají požadavky při více účtech?
Uživatelům s více účty se API požadavky počítají pro každý účet zvlášť.
Jak funguje API u testovacích účtů?
Testovací účty jsou zdarma s limitem API do 10 000 požadavků měsíčně. Při překročení API limitu je doplatek stejný jako u normálních účtů, a to 199 Kč bez DPH za 10 000 API požadavků. 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.
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.
Jak fungují přístupové údaje pro API v3?
Pro API v3 probíhá autorizace přes OAuth 2. Dokumentace k API v3 je dostupná na webu.
Jak probíhá přihlášení 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.
Jak napojit vlastní integraci?
V sekci Nastavení → Uživatelský účet najdete Client ID a Client Secret. Pro více informací nahlédněte přímo do API knihovny.
Jak vyvinout integraci 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), vytvořte novou integraci v Nastavení → Napojení na jiné aplikace → OAuth 2 pro tvůrce aplikací, viz API knihovna.
Vytvoří se speciální Client ID a Client Secret pouze pro tuto integraci.
Pozor na sloučení přihlášení
Pokud máte sloučená přihlášení, pohlídejte, aby integrace správně používala slug účtu, kterého se API požadavek týká - skrze endpoint 'Users' a atribut 'Account', jak popisujeme v dokumentaci.
