InkSmith Press expõe uma API HTTP versionada para modelos compartilhados e trabalhos de renderização de produção. Press Control no Desktop usa o mesmo limite de gerenciamento. A API é para clientes autorizados, não é necessária para o trabalho local do Desktop.
Descubra a instância.
Uma implantação Press expõe GET /health, GET /ready e GET /api/v1/instance. Use prontidão e descoberta de instância para verificar a versão da API, compatibilidade do renderizador e esquema de modelo aceito antes de enviar trabalho.
O servidor deve sentar atrás de seu gateway HTTPS configurado para uso remoto. Siga o Guia de implantação Press para opções de Docker e Windows.
Autenticação e alcance de um cliente
Envie Authorization: Bearer <token> em pedidos protegidos. Os clientes da API só recebem os escopos de que precisam. Para renderização, as permissões relevantes são renders.create, jobs.read e outputs.read. Os escopos de gerenciamento incluem templates.read, templates.write, e templates.publish.
Armazene os modelos externos emitidos, controle de fonte e JavaScript do navegador. Press armazena credenciais de cliente API como hashes e apoia a revogação imediata.
Submeta e recupere um trabalho de renderização.
Só um modelo publicado pode ser renderizado. Um pedido típico é:
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"}}}
O trabalho é assíncrono. Leia GET /api/v1/render-jobs/:id até seu status ser completed, failed ou cancelled. Uma vez concluído, GET /api/v1/render-jobs/:id/output retorna o PDF se o chamador tiver outputs.read.
Reutilize a mesma chave de imunidade após uma falha de rede incerta Apenas para o mesmo pedido e credencial. Reutilizá-lo com entrada alterada produz 409 idempotency_conflict.
Gerencie revisões de modelos
Coleções, modelos, rascunhos, versões e publicações são de propriedade do servidor. Transferências de conteúdo usando application/vnd.inksmith.template. Salvações e publicações requerem a revisão opaca atual em If-Match; uma atualização de rascunho sem validade recebe 412 template_revision_conflict. Uma versão publicada é imutável. Unpublish e Rollback operam na revisão de publicação separada.
Veja Press Control para o fluxo de trabalho de edição do Desktop. O Guia de implantação Press explica os caminhos de hospedagem suportados e os limites atuais.
Âmbito atual: Administração interativa de usuários, certificados e controles de retenção ainda estão em desenvolvimento. Trate a API publicada e cheques de permissão como o contrato, não os ignore com mudanças diretas no banco de dados.