InkSmith Press espone un'API HTTP versioneta per modelli condivisi e lavori di rendering di produzione. Press Control in Desktop utilizza lo stesso limite di gestione. L'API è per i clienti autorizzati; non è necessario per il lavoro desktop locale.
Scopri l'istanza
Una distribuzione Press espone GET /health, GET /ready, e GET /api/v1/instance. Utilizzare la disponibilità e la scoperta delle istanze per controllare la versione API, la compatibilità del renderr e lo schema del modello accettato prima di inviare il lavoro.
Il server dovrebbe sedersi dietro il suo gateway HTTPS configurato per l'uso remoto. Seguire le opzioni Guida di distribuzione Press per Docker e Windows Service.
Autentica e applica un client
Inviare Authorization: Bearer <token> su richieste protette. I client API ricevono solo gli scopi di cui hanno bisogno. Per il rendering, le autorizzazioni pertinenti sono renders.create, jobs.read, e outputs.read. Gli ambiti di gestione includono templates.read, templates.write e templates.publish.
Conservare le credenziali emesse fuori modelli, controllo sorgente e JavaScript del browser. Press memorizza le credenziali API-client come hashes e supporta la revoca immediata.
Inviare e recuperare un lavoro di rendering
Solo un modello pubblicato attivo può essere reso. Una richiesta tipica è:
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"}}}
Il lavoro è asincrono. Leggi GET /api/v1/render-jobs/:id fino a quando il suo stato è completed, failed, o cancelled. Una volta completato, GET /api/v1/render-jobs/:id/output restituisce il PDF se il chiamante ha outputs.read.
Riutilizzare la stessa chiave di idempotency dopo un errore di rete incerto solo per la stessa richiesta e credenziali. La riutilizzazione con ingresso cambiato produce 409 idempotency_conflict.
Gestione delle revisioni dei modelli
Collezioni, modelli, bozze, versioni e pubblicazione sono di proprietà del server. I bozzetti di trasferimento dei contenuti utilizzano application/vnd.inksmith.template. Risparmi e pubblicazione richiedono l'attuale revisione opaca in If-Match; un aggiornamento del progetto stante riceve 412 template_revision_conflict. Una versione pubblicata è immutabile. Unpublish e rollback funzionano sulla revisione della pubblicazione separata.
Vedere Press Control per il flusso di lavoro di editing Desktop. Il Guida di distribuzione Press spiega i percorsi di hosting supportati e i limiti attuali.
Scopo attuale: Gestione interattiva dell'utente e del ruolo, registrazione del certificato e alcuni controlli di ritenzione sono ancora in fase di sviluppo. Trattare le API pubblicate e i controlli di autorizzazione come il contratto; non bypassarli con le modifiche dirette del database.