API propojení
API propojení umožňují bezpečně propojovat Doklado s dalšími aplikacemi a službami. U každého API klíče si můžete nastavit limity jeho využití a sledovat jednotlivé požadavky v historii aktivity.
Více o API si přečtete na stránce Doklado API.
- Kliknutím na ikonu Vývojářská dokumentace se dostanete do dokumentace Doklado API
- Kliknutím na Vygenerovat nový přístupový klíč vygenerujete nový API klíč
Tip od Doklado:Více informací o možnostech API najdete na stránce Doklado API. API je vhodné zejména pro účetní kanceláře a partnerská řešení, která potřebují automatizovaný přenos dokladů.
API propojení
Co získáte
- kontrolu nad spotřebou jednotlivých API klíčů,
- možnost nastavit denní nebo měsíční limit,
- přehled o využití API podle API klíče a endpointu.
Vytvoření API propojení
-
Přejděte do Přehledu účtu.
-
Otevřete sekci API propojení.
-
Klikněte na tlačítko + Nové API propojení.
-
Zadejte Název API propojení.
-
Nastavte limity využití API klíče.
K dispozici máte:
- Neomezený limit využití,
- Denní limit,
- Měsíční limit.
-
Pokud nechcete využití nijak omezovat, označte možnost Neomezený limit využití.
-
Pokud chcete nastavit limit, vyplňte Denní limit, Měsíční limit nebo oba limity.
-
Klikněte na tlačítko Vygenerovat nové propojení.
Nastavení denních a měsíčních limitů
Denní a měsíční limit můžete nastavit samostatně nebo současně.
Pokud chcete využívání API omezit, musí být vyplněn alespoň jeden z limitů. Pokud nastavíte pouze denní limit, měsíční limit zůstává neomezený. Stejně to platí i opačně.
Upozornění: Pokud nechcete API klíč omezovat, můžete nastavit Neomezený limit využití.
Úprava limitů API propojení
Nastavené limity můžete podle potřeby upravovat. Můžete tak změnit denní nebo měsíční limit podle aktuální spotřeby API klíče.
Historie aktivity
Historii používání API najdete v sekci Přehled účtu → API propojení na kartě Historie aktivity.
Historie zobrazuje jednotlivé požadavky uskutečněné prostřednictvím API propojení. U každého požadavku vidíte:
- Název API propojení,
- Datum a čas požadavku,
- volaný Endpoint,
- Spotřebu, která se požadavkem započítala do limitu,
- Stav požadavku.
V historii se zobrazují úspěšné i neúspěšné požadavky.
Požadavky, které byly odeslány po překročení nastaveného limitu, se v historii nezobrazí.
Tip od Doklado: Historie aktivit vám pomůže sledovat, jak se jednotlivá API propojení využívají. Při kontrole spotřeby si můžete prohlédnout konkrétní endpoint, čas požadavku i množství spotřebovaných jednotek.
Překročení limitu
Po vyčerpání nastaveného denního nebo měsíčního limitu nebude API požadavek zpracován a API vrátí odpověď 429 Too Many Requests.
V odpovědi se zároveň zobrazí informace o tom, který nastavený limit byl překročen.
Po překročení limitu se požadavky dále nezobrazují v Historii aktivity.
Upozornění: Při nastavení denního i měsíčního limitu může být požadavek odmítnut po vyčerpání kteréhokoli z nich.