Resumen de la API

• Endpoint: POST https://api.cofferdock.com/pdf-fill-form
• Auth: cabecera x-api-key: TU_LLAVE.
• Entrada: la plantilla va como application/pdf a pelo (con data como JSON url-encoded en Query) o como JSON con { file, data, flatten, inspect }.
• Modo: sin data (o con inspect=true) → inspección, devuelve fields. Con data (aunque sea {}) → relleno.
• Salida del relleno: PDF binario por defecto; con output=json devuelve { pdf, warnings, meta } en base64.
• Campos desconocidos: no bloquean la llamada, van a warnings (o a la cabecera X-Warnings en modo binario, con el número de avisos).
• Límites: plantilla hasta 20 MB (50 MB en Business/Scale) en modo application/pdf, o ~4 MB reales en JSON con base64. 30 peticiones/min por IP. 1 llamada = 1 crédito (inspeccionar o rellenar, por igual).

Tipos de campo soportados

Tipo	Valor esperado en data
text	Cualquier texto.
checkbox	true/false.
radio / dropdown / list	Uno de los valores de options (los ves en el modo inspección).
button / signature	No se pueden rellenar por API; si aparecen en data, van a warnings.

Ejemplos

curl (inspeccionar campos):

curl -X POST "https://api.cofferdock.com/pdf-fill-form" \
  -H "x-api-key: TU_LLAVE" \
  -H "Content-Type: application/pdf" \
  --data-binary @plantilla.pdf

JavaScript (Node 18+, rellenar):

const fs = require('fs');
const r = await fetch('https://api.cofferdock.com/pdf-fill-form', {
  method: 'POST',
  headers: { 'x-api-key': 'TU_LLAVE', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    file: fs.readFileSync('plantilla.pdf').toString('base64'),
    data: { nombre_cliente: 'Ana García', acepto: true },
  }),
});
fs.writeFileSync('relleno.pdf', Buffer.from(await r.arrayBuffer()));

Python (rellenar y aplanar):

import requests, base64
r = requests.post(
    'https://api.cofferdock.com/pdf-fill-form',
    headers={'x-api-key': 'TU_LLAVE', 'Content-Type': 'application/json'},
    json={
        'file': base64.b64encode(open('plantilla.pdf', 'rb').read()).decode(),
        'data': {'nombre_cliente': 'Ana García', 'acepto': True},
        'flatten': True,
    },
)
open('relleno.pdf', 'wb').write(r.content)

Respuesta del modo inspección

{ "success": true, "mode": "inspect",
  "fields": [
    { "name": "nombre_cliente", "type": "text", "value": "" },
    { "name": "acepto", "type": "checkbox", "value": false },
    { "name": "pais", "type": "dropdown", "options": ["ES","US","MX"], "value": null }
  ],
  "meta": { "total_fields": 3, "used": 12, "remaining": 488 } }

Respuesta del relleno (con output=json)

{ "success": true, "mode": "fill", "pdf": "JVBERi0xLjQ…", "mime_type": "application/pdf",
  "warnings": ["Unknown field: \"nombre_clientee\""],
  "meta": { "fields_filled": 2, "flattened": false, "used": 13, "remaining": 487 } }

API overview

• Endpoint: POST https://api.cofferdock.com/pdf-fill-form
• Auth: header x-api-key: YOUR_KEY.
• Input: the template goes as raw application/pdf (with data as URL-encoded JSON in a Query param) or as JSON with { file, data, flatten, inspect }.
• Mode: no data (or inspect=true) → inspect, returns fields. With data (even {}) → fill.
• Fill output: binary PDF by default; with output=json it returns { pdf, warnings, meta } in base64.
• Unknown fields: don't block the call, they go into warnings (or the X-Warnings header in binary mode, with the warning count).
• Limits: template up to 20 MB (50 MB on Business/Scale) in application/pdf mode, or ~4 MB real in JSON with base64. 30 requests/min per IP. 1 call = 1 credit (inspect or fill, equally).

Supported field types

Type	Expected value in data
text	Any text.
checkbox	true/false.
radio / dropdown / list	One of the values in options (visible in inspect mode).
button / signature	Can't be filled via API; if present in data, they go to warnings.

Examples

curl (inspect fields):

curl -X POST "https://api.cofferdock.com/pdf-fill-form" \
  -H "x-api-key: YOUR_KEY" \
  -H "Content-Type: application/pdf" \
  --data-binary @template.pdf

JavaScript (Node 18+, fill):

const fs = require('fs');
const r = await fetch('https://api.cofferdock.com/pdf-fill-form', {
  method: 'POST',
  headers: { 'x-api-key': 'YOUR_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    file: fs.readFileSync('template.pdf').toString('base64'),
    data: { customer_name: 'Jane Doe', agree: true },
  }),
});
fs.writeFileSync('filled.pdf', Buffer.from(await r.arrayBuffer()));

Python (fill and flatten):

import requests, base64
r = requests.post(
    'https://api.cofferdock.com/pdf-fill-form',
    headers={'x-api-key': 'YOUR_KEY', 'Content-Type': 'application/json'},
    json={
        'file': base64.b64encode(open('template.pdf', 'rb').read()).decode(),
        'data': {'customer_name': 'Jane Doe', 'agree': True},
        'flatten': True,
    },
)
open('filled.pdf', 'wb').write(r.content)

Inspect mode response

{ "success": true, "mode": "inspect",
  "fields": [
    { "name": "customer_name", "type": "text", "value": "" },
    { "name": "agree", "type": "checkbox", "value": false },
    { "name": "country", "type": "dropdown", "options": ["ES","US","MX"], "value": null }
  ],
  "meta": { "total_fields": 3, "used": 12, "remaining": 488 } }

Fill response (with output=json)

{ "success": true, "mode": "fill", "pdf": "JVBERi0xLjQ…", "mime_type": "application/pdf",
  "warnings": ["Unknown field: \"customr_name\""],
  "meta": { "fields_filled": 2, "flattened": false, "used": 13, "remaining": 487 } }