Raporty dotyczące API
Z Planfix
Planfix oferuje dwa sposoby pobierania danych raportu przez REST API:
- Możesz utworzyć scheduled report i pobierać jego dane za pomocą 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 okresowy.
- Utwórz token autoryzacyjny dla pracownika, któremu planujesz wysyłać raport. Zapisane dane raportu będą dostępne tylko dla pracowników, których wybierzesz do wysyłki. Aby utworzyć token, przejdź do Zarządzanie kontem — Dostęp do API — REST API — Utwórz nowy token:
- W polu Pracownik / Kontakt określ pracownika, który będzie otrzymywał zaplanowany raport.
- W polu Allowed Scopes wpisz: report_readonly.
- Pobierz listę raportów przez REST API używając metody /report/list i znajdź ID wymaganego raportu w odpowiedzi (ID raportu można też znaleźć w pasku adresu przeglądarki).
- Pobierz listę zapisanych wersji wybranego raportu używając 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 będzie miała kilka części (chunks). Przy pobieraniu danych raportu należy podać indeks części, aby uzyskać wszystkie fragmenty. Używając metody /report/[id]/save/list możesz określić liczbę części raportu.
Generowanie raportów przez REST API
- Utwórz token autoryzacyjny dla pracownika, któremu planujesz wysyłać raport. Zapisane dane raportu będą dostępne tylko dla pracowników, których wybierzesz do wysyłki. Aby utworzyć token, przejdź do Zarządzanie kontem — Dostęp do API — REST API — Utwórz nowy token:
- W polu Pracownik / Kontakt określ pracownika, który będzie otrzymywał raport.
- W polu Allowed Scopes wpisz: report_readonly.
- Wywołaj generowanie raportu, korzystając z endpointu /report/{id}/generate. W odpowiedzi zostanie zwrócony requestId.
- Po krótkiej chwili sprawdź status raportu przy użyciu /report/status/{requestId}.
W odpowiedzi znajdzie się obiekt ReportSave (w tym samym formacie co w raportach zaplanowanych), jeśli raport jest gotowy.
- Pobierz dane raportu po ID zapisanej wersji używając metody /report/{id}/save/{saveId}/data.
Ograniczenia dotyczące generowania
- Dostępne tylko w planie cenowym Corporate.
- Raporty można generować maksymalnie raz na 10 minut.
- Na koncie można jednocześnie generować tylko jeden raport.
- Raporty są generowane w imieniu użytkownika powiązanego z tokenem API i obowiązują uprawnienia tego użytkownika.