Tutte le guide

Team e amministrazione

Endpoint API

Lasci che programmi, script e automazioni inviino documenti a un URL segreto e li stampino.

Un endpoint API è un URL segreto a cui i programmi inviano documenti, per esempio fatture da un sistema ERP, etichette da un negozio online o report da uno script. Ogni documento diventa un lavoro per conto della persona che ha creato l'endpoint e va al percorso dell'endpoint. L'URL stesso è la chiave di accesso, quindi non serve alcun token API. Il riferimento API descrive ogni opzione.

Prerequisiti

  • Il canale di ingresso REST API deve essere attivo in Impostazioni → Canali di ingresso. Nelle nuove organizzazioni è attivo; in quelle meno recenti potrebbe doverlo attivare un amministratore.
  • Ogni membro può creare endpoint API. Gli utenti vedono i propri, gli amministratori tutti gli endpoint dell'organizzazione.
  • Incluso in ogni piano.

Configurazione iniziale

  1. Vada in Sorgenti → Endpoint API e selezioni Nuovo endpoint API.
  2. Inserisca un Nome che indichi a che cosa serve l'endpoint, per esempio "Fatture ERP".
  3. Scelga il Percorso per i documenti la cui richiesta non ne indica alcuno: una destinazione, un gruppo o un flusso di lavoro, Percorso predefinito, oppure Nessun percorso – conserva in Sealed Print.
  4. Selezioni Crea e copi l'URL dell’endpoint nel Suo programma.

Invii il documento come corpo della richiesta con un Content-Type corrispondente:

curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…?name=Invoice" \
  -H "Content-Type: application/pdf" \
  --data-binary @invoice.pdf

Oppure come modulo con il campo file; le opzioni vengono passate come campi del modulo:

curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…" \
  -F "file=@invoice.pdf" \
  -F "name=Invoice" \
  -F "copies=2"

targets invia una singola richiesta altrove tramite identificativo: gli identificativi di destinazioni, gruppi o di un flusso di lavoro, separati da virgole, per esempio targets=office,warehouse (un flusso di lavoro va per primo). destinationId, destinationIds, groupId o workflowId fanno lo stesso tramite ID, e noTarget=true (oppure targets=hold) conserva il documento in Sealed Print. Sostituiscono il percorso dell'endpoint per una singola richiesta; le opzioni di stampa come copies o sides vengono passate come parametri di query o campi del modulo. La risposta è il lavoro (HTTP 201).

Ogni volta

  • Ultimo utilizzo sull'endpoint mostra se un programma invia ancora documenti.
  • Modifica cambia il nome e il percorso; l'URL resta lo stesso.
  • Genera nuovo URL sostituisce l'URL; quello vecchio smette subito di funzionare. Elimina termina l'endpoint definitivamente.
  • Per seguire lo stato di un lavoro dal Suo programma, usi un token API.

Risoluzione dei problemi

  • HTTP 403: il canale di ingresso REST API è disattivato, oppure la persona che ha creato l'endpoint ha lasciato l'organizzazione. Crei un nuovo endpoint con un altro membro.
  • HTTP 404: l'URL è errato o è stato sostituito da uno nuovo. Con il codice unknown_target, un identificativo in targets non esiste o appartiene a una destinazione su cui il proprietario dell'endpoint non può stampare.
  • HTTP 413 o 415: il file è più grande di quanto consente il piano, oppure non è un PDF, JPEG o PNG.
  • L'URL è stato copiato dove non doveva: selezioni subito Genera nuovo URL.

Prossimi passi