InkSmith Press stelt een geversieerde HTTP API bloot voor gedeelde sjablonen en productie render jobs. Press Control in Desktop gebruikt dezelfde beheergrens. De API is voor geautoriseerde klanten; het is niet vereist voor lokale Desktop werk.
Ontdek de instantie
Een Press implementatie stelt GET /health, GET /ready en GET /api/v1/instance bloot. Gebruik bereidheid en instantie ontdekking om de API-versie te controleren, renderer compatibiliteit, en geaccepteerd sjabloon schema voor het verzenden van werk.
De server moet achter de geconfigureerde HTTPS gateway zitten voor gebruik op afstand. Volg de Press implementatiehandleiding voor Docker en Windows Service opties.
Authenticeren en scope van een klant
Stuur Authorization: Bearer <token> naar beschermde verzoeken. API-cliënten ontvangen alleen de scopes die ze nodig hebben. Voor rendering zijn renders.create, jobs.read en outputs.read. Tot de beheersgebieden behoren templates.read, templates.write, en templates.publish.
Bewaar de uitgegeven credential buiten sjablonen, source control en browser JavaScript. Press slaat API-client referenties op als hashes en ondersteunt onmiddellijke intrekking.
Een rendertaak indienen en ophalen
Alleen een actief gepubliceerd sjabloon kan worden weergegeven. Een typisch verzoek is:
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"}}}
Het werk is asynchroon. Lees GET /api/v1/render-jobs/:id totdat de status completed, failed of cancelled is. Eenmaal voltooid, geeft GET /api/v1/render-jobs/:id/output de PDF terug als de beller outputs.read heeft.
Hergebruik dezelfde idempotency key na een onzekere netwerkstoring alleen voor hetzelfde verzoek en geloofwaardigheid. Het hergebruiken met gewijzigde invoer produceert 409 idempotency_conflict.
Sjabloonrevisies beheren
Collecties, sjablonen, ontwerpen, versies en publicatie zijn eigendom van de server. Concept content transfers gebruiken application/vnd.inksmith.template. Besparingen en publicatie vereisen de huidige ondoorzichtige herziening in If-Match; een oude concept update ontvangt 412 template_revision_conflict. Een gepubliceerde versie is onveranderlijk. Op de afzonderlijke publicatie-revisie worden niet-uitgegeven en teruggedraaid.
Zie Press Control voor de bureaubladbewerking workflow. De Press implementatiehandleiding legt de ondersteunde hostingpaden en huidige limieten uit.
Huidige werkingssfeer: Interactieve gebruikers- en rolbeheer, certificaatinschrijving en sommige retentiecontroles zijn nog in ontwikkeling. Behandel de gepubliceerde API en permissie controles als het contract; niet omzeilen met directe database wijzigingen.