Integración API

Conecta tus aplicaciones directamente con el motor de renderizado de DocCoreX.

🔑 Autenticación

Todas las peticiones a la API deben incluir un Bearer Token en el header:

Authorization: Bearer TU_API_KEY

📨 Generación de Documentos

Para generar un documento, envía un POST al endpoint de renderizado con el ID de la plantilla y los datos JSON.

{
  "templateId": "inv-2025-001",
  "data": {
    "customer": "Empresa S.A.S",
    "total": 1500.50
  }
}

📄 Paginación de Resultados

Para los endpoints de listado (ej: auditorías, logs, listas de plantillas), DocCoreX utiliza un patrón de paginación sistemático mediante Skip y Take.

Parámetros de Consulta:

• skip (int): Número de registros a omitir desde el inicio.
• take (int): Número máximo de registros a retornar (máximo recomendado: 50).

Estructura de Respuesta (PaginatedList<T>):

Todas las listas paginadas devuelven un objeto con la siguiente estructura:

{
  "items": [...],      // Array de registros del tipo solicitado
  "totalCount": 150,   // Total global de registros en el sistema
  "skip": 0,           // Registros omitidos en la petición
  "take": 10           // Registros solicitados/retornados
}

Esto permite a los clientes de la API calcular el total de páginas y gestionar la navegación de forma eficiente.