InkSmith Press expone una versión HTTP API para plantillas compartidas y trabajos de renderización de producción. Press Control en Desktop utiliza el mismo límite de gestión. La API es para clientes autorizados; no es necesario para el trabajo local de Escritorio.
Descubre la instancia
Un despliegue de Press expone GET /health, GET /ready, y GET /api/v1/instance. Utilice la preparación y el descubrimiento de instancias para comprobar la versión API, compatibilidad de renderizado y esquema de plantilla aceptado antes de enviar trabajo.
El servidor debe sentarse detrás de su pasarela HTTPS configurada para uso remoto. Siga las opciones Guía de despliegue de Press para Docker y Windows Service.
Autentizar y ampliar un cliente
Enviar Authorization: Bearer <token> en solicitudes protegidas. Los clientes de API sólo reciben los alcances que necesitan. Para la presentación, los permisos pertinentes son renders.create, jobs.read, y outputs.read. Los alcances de gestión incluyen templates.read, templates.write, y templates.publish.
Almacene las plantillas externas credenciales emitidas, el control de fuentes y el navegador JavaScript. Press almacena las credenciales de API-cliente como hashes y admite la revocación inmediata.
Presentar y recuperar un trabajo de renderizado
Sólo se puede hacer una plantilla publicada activa. Una petición típica es:
POST /api/v1/render-jobs
Authorization: Bearer <token>
Content-Type: application/json
Idempotency-Key: invoice-1042
{"template_id":"<published-template-id>","data":{"customer":{"name":"Ada"}}}
El trabajo es asincrónico. Lea GET /api/v1/render-jobs/:id hasta que su estado sea completed, failed, o cancelled. Una vez completado, GET /api/v1/render-jobs/:id/output devuelve el PDF si el callador tiene outputs.read.
Reutilizar la misma clave de idempotencia después de un fallo de red incierto sólo para la misma solicitud y credencial. Reutilizarlo con el cambio de entrada produce 409 idempotency_conflict.
Administrar revisiones de plantillas
Las colecciones, plantillas, borradores, versiones y publicaciones son propiedad del servidor. Los proyectos de transferencia de contenido utilizan application/vnd.inksmith.template. Guarda y publicación requieren la revisión opaca actual en If-Match; un borrador de actualización recibe 412 template_revision_conflict. Una versión publicada es inmutable. La publicación y la devolución funcionan en la revisión separada de la publicación.
Vea Press Control para el flujo de trabajo de edición de escritorio. El Guía de despliegue de Press explica las rutas de hospedaje soportadas y los límites actuales.
Alcance actual: Administración interactiva de usuarios y funciones, inscripción de certificados y algunos controles de retención todavía están en desarrollo. Trate de la API publicada y cheques de permiso como el contrato; no los desvíe con cambios directos de bases de datos.