Skip to main content
POST
Generar PDF de un registro
Genera un archivo PDF con una plantilla creada previamente desde la plataforma. Si es tu primera integración, sigue primero la guía completa. Para llamar este endpoint necesitas:

Endpoint

Parámetros de ruta

Body

Consulta Listar plantillas PDF para conocer los IDs y runtimeFields que acepta la plantilla. También puedes enviar la key de un campo compatible del tablero para sustituir su valor.
No envíes el diseño de la plantilla. La API usa la versión guardada en la plataforma.

Ejemplo: descargar el PDF

Sustituye {databaseId}, {recordId}, <field-id> y <template-id> por los valores de tu tablero. Si la plantilla no tiene runtimeFields, puedes omitir values:

Respuesta exitosa (200)

El body es el archivo PDF. Encabezados relevantes: Los valores enviados no se guardan en el registro. Si una clave también existe en el tablero, el valor del body tiene precedencia solamente durante esta generación.

Recibir el archivo con JavaScript

La respuesta no contiene JSON. Lee el body como bytes:
Sustituye los cuatro IDs. Guarda la API key en IB_API_KEY; no la incluyas directamente en el código fuente.

Límites

  • Máximo 50 propiedades dentro de values.
  • Máximo 10,000 caracteres por string.
  • Valores permitidos: string, número, booleano o null.
  • Máximo 30 generaciones por minuto por API key.
  • La renderización puede tardar hasta 58 segundos.
El límite de 30 se comparte entre todos los tableros y plantillas usados por la misma API key. Al superarlo, la API responde 429.

Errores frecuentes

Los errores incluyen un código estable:
Antes de leer el body como PDF, comprueba siempre response.ok o el código HTTP. Las respuestas de error son JSON.

Authorizations

x-ib-api-key
string
header
required

API key de Insurance Boosters.

Path Parameters

databaseId
string
required

ID del tablero.

recordId
string
required

ID del registro.

Body

application/json
fieldId
string
required

Valor fieldId devuelto por GET /databases/{databaseId}/pdf-templates.

Minimum string length: 1
templateId
string
required

Valor templateId devuelto por GET /databases/{databaseId}/pdf-templates.

Minimum string length: 1
values
object

Valores opcionales indexados por key. Incluye aquí los runtimeFields de la plantilla. Si envías la key de una columna del tablero, sustituye su valor únicamente para este PDF.

Response

Documento PDF generado.

The response is of type file.