Solicitud de Extracción y Descarga de Documentos (RIDE/XML)

Este endpoint inicia una tarea asíncrona para solicitar la extracción y descarga de un documento electrónico (ya sea el PDF/RIDE o el XML) utilizando su clave de acceso única (identifier). La respuesta final con el archivo descargable se recibirá mediante un Webhook.

Detalles Técnicos

Endpoint y Método

• Método: POST
• Endpoint: /tasks - Se está creando una tarea de extracción de documentos

Headers Requeridos

• Content-Type: application/json - Especifica el formato del payload
• x-api-key: [Tu Clave] - Autenticación del servicio
• x-organization-id: [Tu ID de Organización] - Identificador único de la organización solicitante

Estructura del Body/Payload

El payload define la tarea de descarga. Note que es el desarrollador quien elige si quiere el RIDE (PDF) o el XML:

• type (string, requerido): Define el tipo de documento a extraer. Valores posibles son:
  • "RIDE" - Para la representación gráfica, usualmente PDF
  • "XML" - Para el archivo estructurado
• identifier (string, requerido): La clave de acceso completa del documento electrónico
• triggerMethod (string, requerido): Indica cómo se solicitó la tarea. El valor es "API"

Código de Ejemplo

const axios = require('axios');
let data = JSON.stringify({
  "type": "RIDE",
  "identifier": "2404202407176001321000120590020011861860000000012",
  "triggerMethod": "API"
});

let config = {
  method: 'post',
  url: 'https://staging-api.taxo.ws/tasks',
  headers: { 
    'x-api-key': 'tu_api_key',
    'x-organization-id': 'tu_organization_id',
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Respuesta de la solicitud

Al igual que las tareas anteriores, la respuesta inmediata confirma que el pedido fue recibido. La verdadera "magia" (el enlace de descarga) ocurrirá después vía Webhook:

{
  "status": "success",
  "data": {
    "id": "5c635bfc-ada0-4adc-89ca-cd3bb07187aa",
    "createdAt": "2025-11-13T16:30:01.000Z",
    "status": "INITIALIZED"
  }
}

Campos de la Respuesta

• status (string): "success"
• data.id (string): El ID de la tarea de descarga, crucial para el seguimiento
• data.createdAt (string): Marca de tiempo de la solicitud
• data.status (string): El estado inicial de la tarea, "INITIALIZED"

Código de Respuesta HTTP

201 Created: La solicitud de extracción del documento ha sido aceptada y la tarea ha sido encolada para su procesamiento.

Por defecto todas las tareas de extracción empiezan en el estado INITIALIZED que nos indica que la tarea ha sido iniciada y podemos hacer su seguimiento en el webhook.