Docs
ES
English Español
Crear cuenta

Inicio rápido

Genera tu primer PDF con la API REST de ShipPDF en tres pasos. Para ver todos los endpoints, solicitudes y respuestas, consulta la referencia de la API.

1. Crea una clave de API

En tu espacio de trabajo de ShipPDF, abre Miembros y claves y crea una clave de API con los permisos documents:create y documents:read. Trátala como una contraseña.

Consulta Autenticación para configurar tu clave, elegir permisos y resolver errores de autenticación.

Cada solicitud se envía al subdominio api. bajo /v1 y se autentica con un token bearer:

Authorization: Bearer sk_live_xxx

2. Genera un documento

Envía con POST el id de una plantilla publicada junto con los datos que quieres incluir. La llamada consume un crédito de generación y responde de inmediato con un documento cuyo status es queued.

curl -X POST https://api.shippdf.com/v1/documents \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "tmpl_8f3a",
    "data": { "invoice": { "number": "INV-1042" } }
  }'

{ "id": "doc_a1b2c3", "status": "queued", "pdf_url": null }

Incluye un encabezado Idempotency-Key para que los reintentos sean seguros: una repetición con la misma clave reproduce el documento original en lugar de consumir otro crédito.

3. Consulta el PDF

Obtén el documento por su id hasta que status sea completed. La respuesta incluirá entonces un pdf_url de corta duración.

curl https://api.shippdf.com/v1/documents/doc_a1b2c3 \
  -H "Authorization: Bearer sk_live_xxx"

{ "id": "doc_a1b2c3", "status": "completed", "pdf_url": "https://.../doc.pdf" }

¿Prefieres un modelo push? Incluye un webhook_url al generar y ShipPDF enviará el documento a esa URL en cuanto el PDF esté listo.

Próximos pasos