Rapoarte despre API

De la Planfix

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

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

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

Preluarea datelor dintr-un raport programat prin REST API

  • Createți un raport recurent.
  • Creați un token de autorizare pentru angajatul căruia intenționați să-i trimiteți raportul. Datele salvate ale raportului vor fi disponibile doar angajaților pe care i-ați ales ca destinatari. 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 utilizând metoda /report/list și găsiți ID-ul raportului necesar în răspuns (puteți găsi ID-ul raportului și î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.

Considerații privind preluarea datelor

  • Datele salvate ale raportului sunt disponibile doar angajaților pe care îi selectați ca destinatari.
  • Dacă raportul este mare, versiunea va avea mai multe părți (chunk-uri). La obținerea datelor raportului, trebuie să transmiteți indexul chunk-ului pentru a obține toate părțile. Folosind metoda /report/[id]/save/list puteți determina numărul de chunk-uri din raport.

Generarea rapoartelor prin REST API

  • Creați un token de autorizare pentru angajatul căruia intenționați să-i trimiteți raportul. Datele salvate ale raportului vor fi disponibile doar angajaților pe care i-ați ales ca destinatari. 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.
    • În câmpul Allowed Scopes, introduceți: report_readonly.
  • Declanșați generarea raportului utilizând endpoint-ul /report/{id}/generate. Răspunsul va returna un requestId.
  • După o scurtă întârziere, verificați starea raportului folosind /report/status/{requestId}.

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

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

Limitări ale generării

  • Disponibil doar în planul Corporate.
  • Rapoartele pot fi generate cel mult o dată la 10 minute.
  • Doar un singur raport poate fi generat simultan per cont.
  • Rapoartele sunt generate în numele utilizatorului asociat cu token-ul API, iar permisiunile acestuia se aplică.

Mergeți la