Rapoarte despre API

Planfix oferă două modalități de a prelua date din rapoarte prin REST API:

Puteți crea un raport programat și prelua datele sale prin REST API.
Puteți declanșa generarea raportului prin REST API și prelua datele imediat ce sunt gata.

Specificația completă a REST API este disponibilă aici.

Preluarea datelor dintr-un raport programat prin REST API

Creați un token de autorizare pentru angajatul căruia intenționați să îi trimiteți raportul. Datele raportului salvat vor fi disponibile doar angajaților pe care îi selectați pentru trimitere. Pentru a crea un token, accesați Gestionarea contului — Acces la API — REST API — Creați un token nou:
- În câmpul Angajat / Contact specificați angajatul care va primi raportul programat.
- În câmpul Allowed Scopes introduceți: report_readonly.

Preluați lista de rapoarte prin REST API folosind metoda /report/list și găsiți ID-ul raportului necesar în răspuns (puteți găsi ID-ul raportului în bara de adrese a browserului).

Preluați lista versiunilor salvate ale raportului selectat folosind metoda /report/{id}/save/list.

Preluați datele raportului după ID-ul noii versiuni folosind metoda /report/{id}/save/{saveId}/data.

Datele raportului salvat sunt disponibile doar angajaților pe care îi selectați pentru trimitere.
Dacă raportul este mare, versiunea poate avea mai multe părți (chunks). Când preluați datele raportului, trebuie să transmiteți indexul părții pentru a obține toate părțile. Folosind metoda /report/[id]/save/list puteți determina numărul de părți ale raportului.

Creați un token de autorizare pentru angajatul căruia intenționați să îi trimiteți raportul. Datele raportului salvat vor fi disponibile doar angajaților pe care îi selectați pentru trimitere. Pentru a crea un token, accesați Gestionarea contului — Acces la API — REST API — Creați un token nou:
- În câmpul Angajat / Contact specificați angajatul care va primi raportul programat.
- În câmpul Allowed Scopes introduceți: report_readonly.

Declanșați generarea raportului folosind endpoint-ul /report/{id}/generate. Răspunsul va returna un requestId.

După un scurt interval, verificați starea raportului folosind /report/status/{requestId}.

Răspunsul va include un obiect ReportSave (același format ca la rapoartele programate) dacă raportul este gata.

Preluați datele raportului după ID-ul versiunii salvate folosind metoda /report/{id}/save/{saveId}/data.

Disponibil doar în planul Corporate.
Rapoartele pot fi generate cel mult o dată la 10 minute.
La un moment dat poate fi generat un singur raport per cont.
Rapoartele sunt generate în numele utilizatorului asociat token-ului API, iar permisiunile sale de acces se aplică.