Inicio rápido

Cinco minutos hasta tu primer documento

Esta página te lleva de cero a un PDF en disco. Usa la plantilla de factura incluida en todos los espacios de trabajo, por lo que no tienes que diseñar nada antes.

1. Tu clave

Crea una clave en Cuenta → Claves API. El secreto se muestra una sola vez; mantenlo fuera del código fuente. Cada llamada lo incluye en la cabecera X-PDFgine-Key.

# La clave está en el entorno, no en el código
export PDFGINE_KEY="pdfgine_live_..."

# ¿Funciona? Esta llamada lista tus plantillas
curl https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

2. Genera un documento

Una llamada con el código de plantilla y tus datos. La respuesta es 202 con un documentId y una URL de descarga.

curl -X POST https://api.pdfgine.com/api/v1/render \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "templateCode": "invoice",
        "format": "pdf",
        "locale": "es",
        "data": {
          "document": { "title": "Resumen de factura" },
          "referenceNo": "DOC-2026-0042",
          "issueDate": "2026-09-06",
          "currency": "USD",
          "customer": "Northwind Trading Ltd.",
          "lineItems": [
            { "name": "Diagnóstico de averías", "quantity": 2, "unitPrice": 850.00 }
          ]
        }
      }'

Mientras pruebas una plantilla, envía "purpose": "editor-test": esa salida no consume cuota y usa el borrador sin publicar.

3. Descárgalo

La URL de descarga de la respuesta es relativa a la dirección de la API y se solicita con la misma clave. Pide docx en lugar de pdf y los mismos datos se devolverán como archivo Word.

curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -o invoice.pdf

Los primeros errores más habituales

• 402 significa que la cuota mensual de páginas está agotada; la cabecera X-PDFgine-Quota-Remaining te avisa antes de llegar a ese punto.
• 422 significa que tus datos no cumplen los requisitos de la plantilla. El cuerpo indica todos los campos que faltan en errors, sin necesidad de adivinar.
• La renderización responde 202, no 200. Un cliente que considere un fallo cualquier código distinto de 200 notificará un éxito como error.

Próximos pasos

Formatos de datos es la página que más consultarás: indica exactamente cómo deben enviarse una fecha, un importe y una moneda.