Listar plantillas PDF - Insurance Boosters API

GET

databases

{databaseId}

pdf-templates

Listar plantillas PDF

curl --request GET \
  --url https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates \
  --header 'x-ib-api-key: <api-key>'

import requests

url = "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates"

headers = {"x-ib-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates';
const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-ib-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-ib-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-ib-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates")
  .get()
  .addHeader("x-ib-api-key", "<api-key>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-ib-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

{
  "templates": [
    {
      "fieldId": "<field-id>",
      "fieldName": "Generar póliza",
      "templateId": "<template-id>",
      "name": "Póliza",
      "orientation": "portrait",
      "fileNameTemplate": "poliza-{{numeroPoliza}}.pdf",
      "runtimeFields": [
        {
          "key": "observaciones",
          "label": "observaciones"
        }
      ]
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

Lista las plantillas PDF guardadas en un tablero. Usa esta operación antes de generar un documento; no necesitas conocer la estructura interna del campo ni descargar el diseño de la plantilla. Necesitas el databaseId. Si todavía no lo tienes, consulta Listar tableros y usa el id del tablero que contiene la plantilla.

Endpoint

GET /databases/{databaseId}/pdf-templates

Parámetros de ruta

Parámetro	Descripción
`databaseId`	ID del tablero que contiene la plantilla.

Ejemplo de solicitud

curl "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates" \
  -H "x-ib-api-key: TU_API_KEY"

Respuesta exitosa (`200`)

{
  "templates": [
    {
      "fieldId": "<field-id>",
      "fieldName": "Generar póliza",
      "templateId": "<template-id>",
      "name": "Póliza",
      "orientation": "portrait",
      "fileNameTemplate": "poliza-{{numeroPoliza}}.pdf",
      "runtimeFields": [
        {
          "key": "observaciones",
          "label": "observaciones"
        }
      ]
    }
  ]
}

Campos de respuesta

Campo	Descripción
`fieldId`	ID del campo PDF. Envíalo como `fieldId` al generar.
`fieldName`	Nombre visible de la columna en el tablero.
`templateId`	ID de la plantilla. Envíalo como `templateId` al generar.
`name`	Nombre visible de la plantilla. Úsalo para elegir entre varias opciones.
`orientation`	Orientación del documento: `portrait` o `landscape`.
`fileNameTemplate`	Patrón configurado para el nombre del archivo. Puede no aparecer.
`runtimeFields`	Valores solicitados por la plantilla que no provienen del registro.

Por cada elemento de runtimeFields, usa key como propiedad dentro de values al generar el PDF:

{
  "fieldId": "<field-id>",
  "templateId": "<template-id>",
  "values": {
    "observaciones": "Texto capturado al generar"
  }
}

Si runtimeFields es [], no necesitas enviar values; la plantilla puede generarse con los datos del registro. Si templates es [], el tablero no tiene plantillas PDF configuradas.

El diseño y la configuración de las plantillas se administran desde la plataforma.

Errores frecuentes

HTTP	Qué significa	Qué hacer
`401`	API key inválida o faltante.	Verifica el encabezado `x-ib-api-key`.
`404`	El tablero no existe o no está disponible para tu integración.	Confirma `databaseId` con Listar tableros.
`500`	No fue posible consultar las plantillas.	Reintenta; si continúa, contacta soporte.

Authorizations

x-ib-api-key

string

header

required

API key de Insurance Boosters.

Path Parameters

databaseId

string

required

ID del tablero.

Response

Plantillas PDF disponibles.

templates

object[]

required

Show child attributes

Listar plantillas PDF

curl --request GET \
  --url https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates \
  --header 'x-ib-api-key: <api-key>'

import requests

url = "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates"

headers = {"x-ib-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates';
const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-ib-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-ib-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-ib-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates")
  .get()
  .addHeader("x-ib-api-key", "<api-key>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/pdf-templates")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-ib-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

{
  "templates": [
    {
      "fieldId": "<field-id>",
      "fieldName": "Generar póliza",
      "templateId": "<template-id>",
      "name": "Póliza",
      "orientation": "portrait",
      "fileNameTemplate": "poliza-{{numeroPoliza}}.pdf",
      "runtimeFields": [
        {
          "key": "observaciones",
          "label": "observaciones"
        }
      ]
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

​Endpoint

​Parámetros de ruta

​Ejemplo de solicitud

​Respuesta exitosa (200)

​Campos de respuesta

​Errores frecuentes

Authorizations

Path Parameters

Response

Endpoint

Parámetros de ruta

Ejemplo de solicitud

Respuesta exitosa (`200`)

Campos de respuesta

Errores frecuentes