API
Veřejné REST API pro automatizaci a integraci evidence expirací — stejné API, které pohání mobilní aplikaci v Cloud režimu.
Jedno API pro aplikaci i pro vás
Vše, co mobilní aplikace dělá v Cloud režimu, jde přes verzované REST API na /api/v1 — a totéž API je otevřené i vám. Komunikuje v JSON, každý klíč je omezený na jeden workspace a k dispozici je interaktivní OpenAPI (Swagger) dokumentace, kde si každý endpoint můžete rovnou vyzkoušet.
API klíče
API klíče se spravují ve webové aplikaci v Nastavení → API. Každý klíč je vázaný na uživatele, který ho vytvořil, a na jeden konkrétní workspace — dostane se tedy jen k datům daného workspace. Vlastník workspace klíče vytváří a vidí všechny klíče workspace; členové vidí a ruší své vlastní. Hodnota klíče se zobrazí pouze jednou po vytvoření.
Autentizace
Klíč posílejte jako bearer token v hlavičce Authorization. Požadavky běží s oprávněními uživatele klíče v rámci jeho workspace: vlastník spravuje vše, člen položky, které sám vytvořil.
Co API pokrývá
Expirační položky
Výpis, detail s historií událostí, vytvoření, úprava, smazání, obnovení platnosti, archivace a obnovení z archivu.
Kategorie
Správa vlastních kategorií workspace.
Přílohy
Nahrávání, stahování a mazání příloh položek v rámci cloudové kvóty workspace.
Workspace a členové
Správa workspace, přepínání mezi nimi, pozvánky členů e-mailem a odebírání členů či pozvánek.
Připomínky workspace
Vlastník může upravit nebo smazat připomínky kteréhokoli člena workspace.
Účet a synchronizace
Správa profilu a hesla plus endpointy sync-state a export používané mobilní aplikací.
Interaktivní dokumentace
Kompletní a vždy aktuální reference se generuje přímo z kódu jako OpenAPI specifikace. Otevřete Swagger UI, projděte si každý endpoint, jeho parametry a ukázkové odpovědi — a volejte API přímo z prohlížeče.
Otevřít Swagger dokumentaciLimity požadavků
API umožňuje 60 požadavků za minutu na uživatele; endpointy pro přihlášení a registraci 5 požadavků za minutu na IP adresu. Odpovědi používají standardní HTTP stavové kódy s chybami v JSON.
Raději push než dotazování?
Webhooky API doplňují: místo dotazování na změny si nechte události expiračních položek posílat na svůj endpoint s podepsaným payloadem.
Více o webhoocích