Informes sobre la API
Planfix ofrece dos maneras de obtener datos de informes mediante la REST API:
- Puede crear un informe programado y recuperar sus datos a través de la REST API.
- O bien, activar la generación del informe mediante la REST API y recuperar los datos tan pronto como estén listos.
Puede encontrar la especificación completa de la REST API aquí.
Recuperar datos de un informe programado vía REST API
- Crear un informe recurrente.
- Crear un token de autorización para el empleado al que planea enviar el informe. Los datos guardados del informe solo estarán disponibles para los empleados que usted haya seleccionado para recibirlo. Para crear un token, vaya a Administración de la cuenta — Acceso a la API — REST API — Crear un token nuevo:
- En el campo Employee / Contact, especifique el empleado que recibirá el informe programado.
- En el campo Allowed Scopes, ingrese: report_readonly.
- Recupere la lista de informes mediante la REST API usando el método /report/list y encuentre el ID del informe requerido en la respuesta (también puede encontrar el ID del informe en la barra de direcciones del navegador).
- Recupere la lista de versiones guardadas del informe seleccionado usando el método /report/{id}/save/list.
- Recupere los datos del informe por el ID de la nueva versión usando el método /report/{id}/save/{saveId}/data.
Consideraciones sobre la recuperación de datos
- Los datos guardados del informe solo están disponibles para los empleados que seleccione para enviarlos.
- Si el informe es grande, la versión tendrá varias partes (chunks). Al obtener los datos del informe, debe pasar el índice del chunk para obtener todas las partes. Usando el método /report/[id]/save/list puede determinar el número de chunks en el informe.
Generación de informes vía REST API
- Crear un token de autorización para el empleado al que planea enviar el informe. Los datos guardados del informe solo estarán disponibles para los empleados que usted haya seleccionado para recibirlo. Para crear un token, vaya a Administración de la cuenta — Acceso a la API — REST API — Crear un token nuevo:
- En el campo Employee / Contact, especifique el empleado que recibirá el informe programado.
- En el campo Allowed Scopes, ingrese: report_readonly.
- Active la generación del informe usando el endpoint /report/{id}/generate. La respuesta devolverá un requestId.
- Tras una breve espera, compruebe el estado del informe usando /report/status/{requestId}.
La respuesta incluirá un objeto ReportSave (mismo formato que los informes programados) si el informe está listo.
- Recupere los datos del informe por el ID de la versión guardada usando el método /report/{id}/save/{saveId}/data.
Limitaciones de generación
- Disponible solo en el plan de precio Corporate.
- Los informes se pueden generar como máximo una vez cada 10 minutos.
- Solo se puede generar un informe a la vez por cuenta.
- Los informes se generan en nombre del usuario asociado al token de API, y se aplican sus permisos de acceso.