Reporty o API
Planfix nabízí dva způsoby, jak získat data reportu přes REST API:
- Můžete vytvořit scheduled report a získat jeho data přes REST API.
- Spustit generování reportu přes REST API a získat data, jakmile budou připravená.
Úplnou specifikaci REST API najdete zde.
Získávání dat ze plánovaného reportu přes REST API
- Vytvořte opakující se report.
- Vytvořte autorizační token pro Zaměstnance, kterému plánujete report zasílat. Uložená data reportu budou dostupná pouze Zaměstnancům, které vyberete pro zasílání. Pro vytvoření tokenu přejděte do Správa účtu — Přístup k API — REST API — Vytvořit nový token:
- V poli Employee / Contact uveďte Zaměstnance, který bude plánovaný report přijímat.
- V poli Allowed Scopes zadejte: report_readonly.
- Získejte seznam reportů přes REST API pomocí metody /report/list a v odpovědi najděte ID požadovaného reportu (ID reportu najdete i v adresním řádku prohlížeče).
- Získejte seznam uložených verzí vybraného reportu pomocí metody /report/{id}/save/list.
- Získejte data reportu podle ID nové verze pomocí metody /report/{id}/save/{saveId}/data.
Poznámky ke stahování dat
- Uložená data reportu jsou dostupná pouze Zaměstnancům, které vyberete pro zasílání.
- Pokud je report velký, verze může mít několik částí (chunks). Při získávání dat reportu musíte předat index části, abyste získali všechny části. Pomocí metody /report/[id]/save/list můžete zjistit počet částí v reportu.
Generování reportů přes REST API
- Vytvořte autorizační token pro Zaměstnance, kterému plánujete report zasílat. Uložená data reportu budou dostupná pouze Zaměstnancům, které vyberete pro zasílání. Pro vytvoření tokenu přejděte do Správa účtu — Přístup k API — REST API — Vytvořit nový token:
- V poli Employee / Contact uveďte Zaměstnance, který bude plánovaný report přijímat.
- V poli Allowed Scopes zadejte: report_readonly.
- Spusťte generování reportu pomocí endpointu /report/{id}/generate. V odpovědi obdržíte requestId.
- Po krátké prodlevě zkontrolujte stav reportu pomocí /report/status/{requestId}.
V odpovědi bude obsažen objekt ReportSave (ve stejném formátu jako u plánovaných reportů), pokud je report připraven.
- Získejte data reportu podle ID uložené verze pomocí metody /report/{id}/save/{saveId}/data.
Omezení generování
- Dostupné pouze na tarifu Corporate.
- Reporty lze generovat maximálně jednou za 10 minut.
- Na účtu může být současně generován jen jeden report.
- Reporty se generují jménem uživatele spojeného s API tokenem a platí jeho přístupová práva.