Report sulle API
Planfix offre due modi per recuperare i dati dei report tramite la REST API:
- Puoi creare un scheduled report e recuperare i suoi dati tramite la REST API.
- Avviare la generazione del report tramite la REST API e recuperare i dati non appena sono disponibili.
Puoi trovare la specifica completa della REST API qui.
Recupero dei dati da un report pianificato via REST API
- Creare un report ricorrente.
- Creare un token di autorizzazione per il Dipendente a cui prevedi di inviare il report. I dati salvati del report saranno disponibili solo ai Dipendenti che hai scelto come destinatari. Per creare un token, vai su Gestione account — Accesso all'API — REST API — Crea un nuovo token:
- Nel campo Employee / Contact, specifica il Dipendente che riceverà il report pianificato.
- Nel campo Allowed Scopes, inserisci: report_readonly.
- Recuperare l'elenco dei report tramite la REST API usando il metodo /report/list e trovare l'ID del report richiesto nella risposta (puoi trovare l'ID del report nella barra degli indirizzi del browser).
- Recuperare l'elenco delle versioni salvate del report selezionato usando il metodo /report/{id}/save/list.
- Recuperare i dati del report tramite l'ID della nuova versione usando il metodo /report/{id}/save/{saveId}/data.
Considerazioni sul recupero dei dati
- I dati salvati del report sono disponibili solo ai Dipendenti che selezioni come destinatari.
- Se il report è di grandi dimensioni, la versione avrà più parti (chunk). Quando si ottengono i dati del report, è necessario passare l'indice del chunk per ottenere tutti i chunk. Utilizzando il metodo /report/[id]/save/list, puoi determinare il numero di chunk nel report.
Generazione dei report via REST API
- Creare un token di autorizzazione per il Dipendente a cui prevedi di inviare il report. I dati salvati del report saranno disponibili solo ai Dipendenti che hai scelto come destinatari. Per creare un token, vai su Gestione account — Accesso all'API — REST API — Crea un nuovo token:
- Nel campo Employee / Contact, specifica il Dipendente che riceverà il report pianificato.
- Nel campo Allowed Scopes, inserisci: report_readonly.
- Avviare la generazione del report usando l'endpoint /report/{id}/generate. La risposta restituirà un requestId.
- Dopo un breve intervallo, controllare lo stato del report tramite /report/status/{requestId}.
La risposta includerà un oggetto ReportSave (stesso formato dei report pianificati) se il report è pronto.
- Recuperare i dati del report tramite l'ID della versione salvata usando il metodo /report/{id}/save/{saveId}/data.
Limitazioni della generazione
- Disponibile solo nel piano tariffario Corporate.
- I report possono essere generati al massimo una volta ogni 10 minuti.
- Solo un report può essere generato alla volta per account.
- I report sono generati per conto dell'utente associato al token API e si applicano le sue autorizzazioni di accesso.