Raporty dotyczące API
Planfix oferuje dwa sposoby pobierania danych raportów za pomocą REST API:
- Możesz utworzyć raport zaplanowany i pobrać jego dane przez REST API.
- Wywołać wygenerowanie raportu przez REST API i pobrać dane, gdy tylko będą gotowe.
Pełną specyfikację REST API znajdziesz tutaj.
Pobieranie danych z zaplanowanego raportu przez REST API
- Utwórz raport cykliczny.
- Utwórz token autoryzacyjny dla Pracownika, któremu planujesz wysłać raport. Zapisane dane raportu będą dostępne tylko dla Pracowników, którym je wyślesz. Aby utworzyć token, przejdź do Zarządzanie kontem — Dostęp do API — REST API — Utwórz nowy token:
- W polu Employee / Contact podaj Pracownika, który ma otrzymywać zaplanowany raport.
- W polu Allowed Scopes wpisz: report_readonly.
- Pobierz listę raportów przez REST API za pomocą metody /report/list i znajdź ID wymaganego raportu w odpowiedzi (ID raportu możesz też znaleźć w pasku adresu przeglądarki).
- Pobierz listę zapisanych wersji wybranego raportu przy użyciu metody /report/{id}/save/list.
- Pobierz dane raportu po ID nowej wersji używając metody /report/{id}/save/{saveId}/data.
Uwagi dotyczące pobierania danych
- Zapisane dane raportu są dostępne tylko dla Pracowników, których wybierzesz do wysyłki.
- Jeśli raport jest duży, wersja może mieć kilka części (chunk). Podczas pobierania danych raportu musisz podać indeks chunku, aby otrzymać wszystkie części. Korzystając z metody /report/[id]/save/list, możesz ustalić liczbę chunków w raporcie.
Generowanie raportów przez REST API
- Utwórz token autoryzacyjny dla Pracownika, któremu planujesz wysłać raport. Zapisane dane raportu będą dostępne tylko dla Pracowników, którym je wyślesz. Aby utworzyć token, przejdź do Zarządzanie kontem — Dostęp do API — REST API — Utwórz nowy token:
- W polu Employee / Contact podaj Pracownika, który ma otrzymywać zaplanowany raport.
- W polu Allowed Scopes wpisz: report_readonly.
- Wywołaj wygenerowanie raportu za pomocą endpointu /report/{id}/generate. W odpowiedzi otrzymasz requestId.
- Po krótkiej chwili sprawdź status raportu używając /report/status/{requestId}.
W odpowiedzi, jeśli raport jest gotowy, otrzymasz obiekt ReportSave (ten sam format co w raportach zaplanowanych).
- Pobierz dane raportu po ID zapisanej wersji używając metody /report/{id}/save/{saveId}/data.
Ograniczenia generowania
- Dostępne tylko w planie cenowym Corporate.
- Raporty można generować nie częściej niż raz na 10 minut.
- W danym koncie można jednocześnie generować tylko jeden raport.
- Raporty są generowane w imieniu użytkownika powiązanego z tokenem API i obowiązują jego uprawnienia dostępu.