Dirección base
Dirección base
Todos los endpoints se encuentran bajo este prefijo. En una instalación local, la dirección predeterminada es el valor siguiente.
https://api.pdfgine.com/api/v1
Paginación de los endpoints de listado
Cinco endpoints de listado tienen paginación: /history de una plantilla, /assets, /marketplace/templates, /templates y /components. Todos admiten limit (1-200) y before opcionales, y siguen respondiendo con un array simple, por lo que los clientes actuales no tienen que cambiar.
Sin limit recibes como máximo 200 filas y, si hay más, la respuesta incluye una cabecera Link con rel="next". Sigue ese enlace en lugar de construir la siguiente URL: el cursor es un número de versión en history, un ID de recurso en assets y un valor opaco en los demás casos; solo la cabecera conoce el formato. En /marketplace/templates el cursor también incluye los filtros, por lo que deja de funcionar al cambiar search, category o locale: es intencionado, porque de lo contrario el mismo cursor apuntaría a otra lista. Los demás endpoints de listado devuelven colecciones ya limitadas. Una respuesta truncada también incluye X-PDFgine-List-Truncated: true y X-PDFgine-List-Limit; ninguno aparece en la última página.
La descripción legible por máquinas
Todo lo que aparece en estas páginas también se publica como un documento OpenAPI 3.0. Usa su dirección en tu generador de clientes, Postman o un editor para obtener las rutas, los cuerpos de las solicitudes y las cargas de ejemplo sin copiar nada a mano.
https://api.pdfgine.com/openapi/v1.json
El documento se genera a partir de la API en ejecución, por lo que describe la versión que realmente llamas, no la que alguien recordó documentar.