Skip to main content

Extracción de información desde Parsable

La extracción de información desde Parsable se realiza mediante un conjunto de procesos asíncronos que permiten obtener información de Jobs, Deviations y recursos asociados, como imágenes.

Para realizar la extracción se utilizan diferentes APIs de Parsable, dependiendo del tipo de información requerida. Los flujos se ejecutan de manera independiente y permiten obtener los datos necesarios para su posterior procesamiento e integración con la plataforma.

Actualmente, la integración contempla tres flujos para la obtención de información desde Parsable:

  • Jobs: extracción asíncrona mediante 4 endpoints secuenciales.
  • Deviations: extracción asíncrona mediante 4 endpoints secuenciales.
  • Imágenes: recuperación de recursos gráficos mediante un endpoint independiente.
Nota:

En conjunto, estas APIs permiten obtener la información operativa de Parsable y sus recursos asociados para posteriormente procesarla y almacenarla en los sistemas de destino.


1. Glosario de Parámetros y Variables​

Para facilitar la integración y comprensión del flujo de extracción de datos, a continuación se detallan los identificadores, variables de entorno y tokens utilizados en esta documentación:

Variable / ParámetroTipoOrigen / ÁmbitoDescripción
url_reportesConfiguraciónEntorno (.env)URL raíz utilizada para consumir los servicios de Parsable relacionados con la generación y descarga de reportes de Jobs y Deviations. Valor: https://api.us-west-2.parsable.net/.
url_imagenesConfiguraciónEntorno (.env)URL raíz utilizada para consumir los servicios de Parsable relacionados con la recuperación de imágenes. Valor: https://api.parsable.net/.
token_reportesCredencialConfiguración / ProveedorToken de autenticación proporcionado por el proveedor de Parsable y configurado de forma fija para el consumo de los servicios de reportes de Jobs y Deviations. Se envía en el header Authorization utilizando el esquema Bearer.
token_imagenesCredencialConfiguración / ProveedorToken de autenticación proporcionado por el proveedor de Parsable y configurado de forma fija para el consumo de los servicios de recuperación de imágenes. Se envía en el header Authorization utilizando el esquema Token.
team_idIdentificadorPlataforma ParsableCódigo único global que identifica a la organización o equipo de Alpura dentro del tenant de Parsable.
report_idIdentificadorDinámicoID único asignado a la tarea de compilación del reporte asíncrono. Se genera al solicitar la exportación de datos de los formularios.
file_parsable_idIdentificadorDinámicoID único asignado a cada Archivo que se encuentra en Parsable.
signedDownloadUrlURLDinámicoEnlace seguro y firmado criptográficamente que apunta directamente al almacenamiento en la nube (CloudFront/S3). Contiene tokens de expiración y firma mutua.
parsable-custom-touchstoneIdentificadorConfiguración / ProveedorIdentificador proporcionado por Parsable para localizar y direccionar los servicios que serán invocados. Para la integración con Alpura se utiliza el valor parsable-alpura-touchstone, de acuerdo con la configuración e indicaciones proporcionadas por el proveedor.
Nota de Seguridad

Los valores de token_reportes, token_imagenes, y las firmas dinámicas dentro de signedDownloadUrl contienen credenciales de acceso a datos sensibles de producción (calidad, ranchos, asesores). Nunca deben quedar expuestos de forma fija en repositorios públicos de código.


2. Flujos de extracción​

La integración con Parsable contempla tres flujos principales para la obtención de información. Los flujos de Jobs y Deviations utilizan un mecanismo asíncrono de generación de reportes, mientras que la recuperación de imágenes se realiza mediante un servicio específico proporcionado por Parsable.

Los flujos de extracción de reportes siguen una secuencia de 4 endpoints, en la cual cada etapa depende del resultado obtenido en la etapa anterior. Este mecanismo permite solicitar la generación de la información, consultar su disponibilidad, obtener una URL temporal de descarga y finalmente consumir el archivo generado.

La recuperación de imágenes utiliza un endpoint independiente y una URL base diferente a la utilizada para los reportes.


2.1 Jobs​

La extracción de información de Jobs se realiza mediante un proceso asíncrono que involucra 4 endpoints secuenciales.

Este flujo permite:

PasoMétodoEndpoint / URLDescripción
1POST/v2/csv-reports/v1/reports/{team_id}/jobs-inputsSolicita la generación del reporte. Retorna un report_id.
2GET/v2/csv-reports/v1/reports/{team_id}/jobs-inputs/{report_id}Consulta el estado del procesamiento (Polling).
3GET/v2/csv-reports/v1/reports/{team_id}/jobs-inputs/{report_id}/fileObtiene la URL firmada de descarga una vez esté READY.
4GET{signedDownloadUrl}Descarga el archivo físico .csv desde el servidor de almacenamiento.
URL

Los flujos de extracción de Jobs utilizan la URL base definida en la variable url_reportes, correspondiente al servicio regional de reportes de Parsable: https://api.us-west-2.parsable.net/.


2.2 Deviations​

La extracción de información de Deviations utiliza un proceso asíncrono similar al empleado para Jobs y está compuesto por 4 endpoints secuenciales.

El flujo permite:

PasoMétodoEndpoint / URLDescripción
1POST/api/v3/teams/{team_id}/csv-reports/deviationsSolicita la generación del reporte. Retorna un report_id.
2GET/api/v3/teams/{team_id}/csv-reports/deviations/{report_id}Consulta el estado del procesamiento (Polling).
3GET/api/v3/teams/{team_id}/csv-reports/deviations/{report_id}/fileObtiene la URL firmada de descarga una vez esté READY.
4GET{signedDownloadUrl}Descarga el archivo físico .csv desde el servidor de almacenamiento.
URL

Los flujos de extracción de Deviations utilizan la URL base definida en la variable url_reportes, correspondiente al servicio regional de reportes de Parsable: https://api.us-west-2.parsable.net/.


2.3 Imágenes​

Adicionalmente, se cuenta con un endpoint destinado a la recuperación de imágenes asociadas a la información extraída desde Parsable.

MétodoEndpoint / URLDescripción
GET/api/documents/{file_parsable_id}/locatorRecupera la imagen almacenada en Parsable de acuerdo al file_parsable_id.
URL

La Recuperación de Imagenes utiliza la URL base definida en la variable url_imagenes, correspondiente al servicio regional de reportes de Parsable: https://api.parsable.net/.


3. Diagrama General​


3.1. Diagrama Jobs​


3.2. Diagrama Deviations​


3.3. Diagrama Imagenes​


4. Explicación de los Flujos de Comunicación​

La integración con Parsable contempla tres flujos de comunicación para la obtención de información y recursos:

  1. Jobs: extracción asíncrona de información de Jobs mediante la generación y descarga de un reporte CSV.
  2. Deviations: extracción asíncrona de información de Deviations mediante la generación y descarga de un reporte CSV.
  3. Imágenes: recuperación directa de imágenes asociadas a los registros obtenidos desde Parsable.

Los flujos de Jobs y Deviations utilizan un mecanismo de procesamiento asíncrono compuesto por cuatro pasos: solicitud del reporte, consulta de estado, obtención de la URL de descarga y descarga del archivo.

El flujo de Imágenes es independiente y realiza directamente la recuperación del recurso mediante el identificador de archivo proporcionado por Parsable.

PasoTipoDescripción
1SolicitudEl sistema cliente inicializa el flujo enviando una petición HTTP POST con los criterios de filtrado específicos al endpoint del equipo. La API de Parsable procesa la solicitud de forma asíncrona debido al volumen potencial de datos y devuelve un código 202 Accepted junto con un identificador único de seguimiento denominado report_id (ej. 6a3aaf3a0d7387409fa6bafa).
2PollingEl sistema cliente inicia un ciclo de consulta periódica (Polling Loop) mediante peticiones HTTP GET cada 5 a 10 segundos, utilizando el report_id obtenido en el Paso 1. El proceso continúa hasta obtener un estado final del reporte.
3Firma / AutorizaciónUna vez que el reporte alcanza el estado READY, el sistema cliente realiza una petición HTTP GET al endpoint /file para obtener la URL temporal y firmada de descarga (signedDownloadUrl).
4DescargaEl sistema cliente realiza una petición HTTP GET directamente sobre signedDownloadUrl para descargar el archivo físico .csv desde el almacenamiento seguro.

5. Especificación Técnica de los Endpoints​

5.1. Jobs - Solicitud​

Este endpoint permite solicitar la generación de un reporte CSV basado en los inputs de los trabajos (jobs-inputs), aplicando filtros avanzados por fechas, tipos de trabajo y plantillas específicas de Parsable.

Información General​

ElementoValor
Método HTTPPOST
URL<url_api_reportes>/v2/csv-reports/v1/reports/<team_id>/jobs-inputs
Content-Typeapplication/json
AuthorizationBearer <token_reportes>

{
"jobTypes": ["Normal"],
"createdDate": {
"from": "<fecha_inicio>",
"to": "<fecha_fin>"
},
"templates": {
<templates>
},
"businessFunctions": [],
"businessUnits": [],
"locations": [],
"jobIds": [],
"excludeEmptyInputFields": false,
"columns": []
}
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<fecha_inicio>Fecha y hora inicial del periodo a consultar, utilizando el formato ISO 8601 en UTC. Ejemplo: 2026-06-01T06:00:00.000Z.
<fecha_fin>Fecha y hora final del periodo a consultar, utilizando el formato ISO 8601 en UTC. Ejemplo: 2026-06-22T05:59:59.999Z.
<templates>Identificadores de los templates que se incluirán en la extracción. Los templates deben definirse de acuerdo con las reglas de negocio correspondientes.

Los templates utilizados actualmente son:

{
"711177e4-b93a-485d-a838-2c52d90423e5": [],
"bf7a6a62-c225-4311-8149-58b3aaffe5b7": []
}

5.2. Jobs - Polling​

Este endpoint permite consultar periódicamente el estado de procesamiento de un reporte CSV de Jobs (jobs-inputs) previamente solicitado, utilizando el report_id generado en la Jobs - Solicitud. La consulta se realiza mediante un mecanismo de Polling hasta que el reporte alcance un estado final.

Información General​

ElementoValor
Método HTTPGET
URL<url_api_reportes>/v2/csv-reports/v1/reports/<team_id>/jobs-inputs/<report_id>
Content-Typeapplication/json
AuthorizationBearer <token_reportes>

curl --location '<url_api_reportes>/v2/csv-reports/v1/reports/<team_id>/jobs-inputs/<report_id>' \
--header 'Authorization: Bearer <token_reportes>'
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<url_api_reportes>URL base utilizada para consumir los servicios de reportes de Parsable. Para este flujo corresponde a https://api.us-west-2.parsable.net/.
<team_id>Identificador único del equipo de Alpura dentro de Parsable.
<report_id>ID del Reporte que se recupera con el servicio de Jobs - Solicitud
<token_reportes>Token de autenticación proporcionado por Parsable para el consumo de los servicios de reportes. Se envía en la cabecera Authorization utilizando el esquema Bearer.

5.3. Jobs - Firma/Autorización​

Este endpoint permite obtener la URL temporal y firmada de descarga (signedDownloadUrl) de un reporte CSV de Jobs (jobs-inputs) cuyo procesamiento ha finalizado correctamente. La solicitud debe realizarse utilizando el report_id obtenido durante en la Jobs - Solicitud y únicamente cuando el estado del reporte sea READY.

Información General​

ElementoValor
Método HTTPGET
URL<url_api_reportes>/v2/csv-reports/v1/reports/<team_id>/jobs-inputs/<report_id>/file
Content-Typeapplication/json
AuthorizationBearer <token_reportes>

curl --location '<url_api_reportes>/v2/csv-reports/v1/reports/<team_id>/jobs-inputs/<report_id>/file' \
--header 'Authorization: Bearer <token_reportes>'
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<url_api_reportes>URL base utilizada para consumir los servicios de reportes de Parsable. Para este flujo corresponde a https://api.us-west-2.parsable.net/.
<team_id>Identificador único del equipo de Alpura dentro de Parsable.
<report_id>ID del Reporte que se recupera con el servicio de Jobs - Solicitud
<token_reportes>Token de autenticación proporcionado por Parsable para el consumo de los servicios de reportes. Se envía en la cabecera Authorization utilizando el esquema Bearer.

5.4. Jobs - Descarga​

Este endpoint permite descargar el archivo CSV generado por Parsable mediante la URL temporal y firmada (signedDownloadUrl) obtenida en el Jobs - Firma/Autorización. La descarga se realiza directamente desde el servicio de almacenamiento asociado a Parsable y no requiere enviar nuevamente el token de autenticación utilizado en los pasos anteriores.

Información General

ElementoValor
Método HTTPGET
URL<signedDownloadUrl>

curl --location '<signedDownloadUrl>'
Comportamiento del Storage

El servidor de storage lee los query parameters inyectados dentro de la propiedad signedDownloadUrl (Signature, Expires, versionId, Key-Pair-Id), valida la firma delegada y abre un canal de transmisión de datos directos (Stream) devolviendo un encabezado Content-Type: text/csv.


5.5. Deviations - Solicitud​

Este endpoint permite solicitar la generación de un reporte CSV basado en las Deviations registradas en Parsable, aplicando los criterios de filtrado definidos para la extracción.

Información General​

ElementoValor
Método HTTPPOST
URL<url_api_reportes>/api/v3/teams/<team_id>/csv-reports/deviations
Content-Typeapplication/json
AuthorizationBearer <token_reportes>
parsable-custom-touchstoneparsable-alpura-touchstone

{
"deviationCreatedDate": {
"from": "<fecha_inicio>",
"to": "<fecha_fin>"
},
"templates": {
<templates>
}
}
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<fecha_inicio>Fecha y hora inicial del periodo a consultar, utilizando el formato ISO 8601 en UTC. Ejemplo: 2026-06-01T06:00:00.000Z.
<fecha_fin>Fecha y hora final del periodo a consultar, utilizando el formato ISO 8601 en UTC. Ejemplo: 2026-06-22T05:59:59.999Z.
<templates>Identificadores de los templates que se incluirán en la extracción. Los templates deben definirse de acuerdo con las reglas de negocio correspondientes.

Los templates utilizados actualmente son:

{
"711177e4-b93a-485d-a838-2c52d90423e5": [],
"bf7a6a62-c225-4311-8149-58b3aaffe5b7": []
}

5.6. Deviations - Polling​

Este endpoint permite consultar periódicamente el estado de procesamiento de un reporte CSV de Deviations previamente solicitado, utilizando el report_id generado en Deviations - Solicitud. La consulta se realiza mediante un mecanismo de Polling hasta que el reporte alcance un estado final.

Información General​

ElementoValor
Método HTTPPOST
URL<url_api_reportes>/api/v3/teams/<team_id>/csv-reports/deviations/<report_id>
Content-Typeapplication/json
AuthorizationBearer <token_reportes>
parsable-custom-touchstoneparsable-alpura-touchstone

curl --location '<url_api_reportes>/api/v3/teams/<team_id>/csv-reports/deviations/<report_id>' \
--header 'accept: application/json' \
--header 'parsable-custom-touchstone: <parsable-custom-touchstone>' \
--header 'Authorization: Bearer <token_reportes>' \
--header 'Content-Type: application/json' \
--data ''
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<url_api_reportes>URL base utilizada para consumir los servicios de reportes de Parsable. Para este flujo corresponde a https://api.us-west-2.parsable.net/.
<team_id>Identificador único del equipo de Alpura dentro de Parsable.
<report_id>ID del Reporte que se recupera con el servicio de Deviations - Solicitud
<parsable-custom-touchstone>Identificador para indetificar las peticiones de Alpura Default dentro de Parsable parsable-alpura-touchstone.
<token_reportes>Token de autenticación proporcionado por Parsable para el consumo de los servicios de reportes. Se envía en la cabecera Authorization utilizando el esquema Bearer.

5.7. Deviations - Firma/Autorización​

Este endpoint permite obtener la URL temporal y firmada de descarga (signedDownloadUrl) de un reporte CSV de Deviations cuyo procesamiento ha finalizado correctamente. La solicitud debe realizarse utilizando el report_id obtenido durante Deviations - Solicitud y únicamente cuando el estado del reporte sea READY.

Información General​

ElementoValor
Método HTTPPOST
URL<url_api_reportes>/api/v3/teams/<team_id>/csv-reports/deviations/<report_id>/file
Content-Typeapplication/json
AuthorizationBearer <token_reportes>
parsable-custom-touchstoneparsable-alpura-touchstone

curl --location '<url_api_reportes>/api/v3/teams/<team_id>/csv-reports/deviations/<report_id>/file' \
--header 'accept: application/json' \
--header 'parsable-custom-touchstone: <parsable-custom-touchstone>' \
--header 'Authorization: Bearer e<token_reportes>' \
--header 'Content-Type: application/json' \
--data ''
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<url_api_reportes>URL base utilizada para consumir los servicios de reportes de Parsable. Para este flujo corresponde a https://api.us-west-2.parsable.net/.
<team_id>Identificador único del equipo de Alpura dentro de Parsable.
<report_id>ID del Reporte que se recupera con el servicio de Deviations - Solicitud
<parsable-custom-touchstone>Identificador para indetificar las peticiones de Alpura Default dentro de Parsable parsable-alpura-touchstone.
<token_reportes>Token de autenticación proporcionado por Parsable para el consumo de los servicios de reportes. Se envía en la cabecera Authorization utilizando el esquema Bearer.

5.8. Deviations - Descarga​

Este endpoint permite descargar el archivo CSV de Deviations generado por Parsable mediante la URL temporal y firmada (signedDownloadUrl) obtenida en Deviations - Firma/Autorización. La descarga se realiza directamente desde el servicio de almacenamiento asociado a Parsable y no requiere enviar nuevamente el token de autenticación utilizado en los pasos anteriores.

Información General​

ElementoValor
Método HTTPGET
URL<signedDownloadUrl>

curl --location '<signedDownloadUrl>'
Comportamiento del Storage

El servidor de storage lee los query parameters inyectados dentro de la propiedad signedDownloadUrl (Signature, Expires, versionId, Key-Pair-Id), valida la firma delegada y abre un canal de transmisión de datos directos (Stream) devolviendo un encabezado Content-Type: text/csv.


5.9. Imagenes - Solicitud / Recuperación​

Este endpoint permite recuperar una imagen asociada a un archivo almacenado en Parsable, utilizando el identificador file_parsable_id proporcionado por la plataforma.

Información General​

ElementoValor
Método HTTPGET
URL<url_imagenes>/api/documents/<file_parsable_id>/locator
Acceptapplication/json
AuthorizationToken <token_imagenes>

cURL​

curl --location '<url_imagenes>/api/documents/<file_parsable_id>/locator' \
--header 'Authorization: Token <token_imagenes>' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data ''
Parámetros dinámicos

Antes de ejecutar la solicitud, reemplaza los siguientes valores:

ParámetroDescripción
<url_imagenes>URL base utilizada para consumir los servicios de recuperación de imágenes de Parsable. Corresponde a https://api.parsable.net/.
<file_parsable_id>Identificador único del archivo o recurso almacenado en Parsable que se desea recuperar. Este identificador es proporcionado por Parsable y permite localizar la imagen asociada.
<token_imagenes>Token de autenticación proporcionado por Parsable para el consumo del servicio de recuperación de imágenes. Se envía en la cabecera Authorization utilizando el esquema Token.