Team und Verwaltung
API-Endpunkte
Lassen Sie Programme, Skripte und Automatisierungen Dokumente an eine geheime URL senden und drucken.
Ein API-Endpunkt ist eine geheime URL, an die Programme Dokumente senden, zum Beispiel Rechnungen aus einem ERP-System, Etiketten aus einem Onlineshop oder Berichte aus einem Skript. Jedes Dokument wird zu einem Auftrag im Namen der Person, die den Endpunkt angelegt hat, und geht an das Ziel des Endpunkts. Die URL selbst ist der Zugangsschlüssel, ein API-Token ist nicht nötig. Die API-Referenz beschreibt jede Option.
Voraussetzungen
- Der Eingangskanal REST API muss unter Einstellungen → Eingangskanäle eingeschaltet sein. In neuen Organisationen ist er an; in älteren muss ihn eventuell ein Admin einschalten.
- Jedes Mitglied kann API-Endpunkte anlegen. Benutzer sehen ihre eigenen, Admins alle Endpunkte der Organisation.
- In jedem Tarif enthalten.
Einmalige Einrichtung
- Gehen Sie zu Quellen → API-Endpunkte und wählen Sie Neuer API-Endpunkt.
- Geben Sie einen Namen ein, der sagt, wofür der Endpunkt verwendet wird, zum Beispiel „Rechnungen aus dem ERP“.
- Wählen Sie das Ziel für Dokumente, deren Anfrage keines nennt: ein Ziel, eine Gruppe oder einen Ablauf, Standardziel (das Standardziel der Person, der der Endpunkt gehört) oder Kein Ziel – in Sealed Print behalten.
- Wählen Sie Erstellen und kopieren Sie die Endpunkt-URL in Ihr Programm.
Senden Sie das Dokument als Anfragekörper mit passendem Content-Type:
curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…?name=Invoice" \
-H "Content-Type: application/pdf" \
--data-binary @invoice.pdf
Oder als Formular mit dem Feld file; Optionen gehen als Formularfelder mit:
curl -X POST "https://www.sealedprint.com/api/print/sp_ep_…" \
-F "file=@invoice.pdf" \
-F "name=Invoice" \
-F "copies=2"
targets schickt eine Anfrage über Kennungen woandershin: die Kennungen von Zielen, Zielgruppen oder einem Ablauf,
durch Kommas getrennt, zum Beispiel targets=office,warehouse (ein Ablauf steht vorne). destinationId,
destinationIds, groupId oder workflowId tun dasselbe über die ID, und noTarget=true (oder targets=hold) behält
das Dokument in Sealed Print. Sie ersetzen das Ziel des Endpunkts für eine Anfrage; Druckoptionen wie
copies oder sides geben Sie als Query-Parameter oder Formularfelder mit. Die Antwort ist der Auftrag (HTTP 201).
Jedes Mal
- Zuletzt verwendet am Endpunkt zeigt, ob ein Programm noch Dokumente sendet.
- Bearbeiten ändert Name und Ziel; die URL bleibt gleich.
- Neue URL erzeugen ersetzt die URL; die alte funktioniert sofort nicht mehr. Löschen beendet den Endpunkt endgültig.
- Um den Status eines Auftrags aus Ihrem Programm zu verfolgen, verwenden Sie ein API-Token.
Fehlerbehebung
- HTTP 403: Der Eingangskanal REST API ist ausgeschaltet, oder die Person, die den Endpunkt angelegt hat, hat die Organisation verlassen. Legen Sie mit einem anderen Mitglied einen neuen Endpunkt an.
- HTTP 404: Die URL ist falsch oder wurde durch eine neue ersetzt. Mit dem Code
unknown_targetgibt es eine Kennung intargetsnicht, oder sie gehört zu einem Ziel, an das die Person, der der Endpunkt gehört, nicht drucken darf. - HTTP 413 oder 415: Die Datei ist größer, als der Tarif erlaubt, oder kein PDF, JPEG oder PNG.
- Die URL wurde an eine Stelle kopiert, an die sie nicht gehört: Wählen Sie sofort Neue URL erzeugen.
Wie geht es weiter
- API-Referenz: jeder Endpunkt, mit der OpenAPI-Beschreibung.
- API-Tokens
- Eingangs- und Ausgangskanäle
- Stripe-Dokumente drucken: Rechnungen, Gutschriften und Angebote aus Stripe über einen API-Endpunkt.