Zum Inhalt springen

Dokument zum Drucken hochladen

Laden Sie vor dem Erstellen eines Druckauftrags ein druckfertiges PDF oder explizite RAW-Druckersprachdaten hoch.

POST/api/v1/documentsAPI-Version: v1operationId: uploadDocumentAls Markdown anzeigen

Funktion dieser Methode

Laden Sie vor dem Erstellen eines Druckauftrags ein druckfertiges PDF oder explizite RAW-Druckersprachdaten hoch.

Authentifizierung

Senden Sie ein kurzlebiges Token in Authorization: Bearer <access_token>.

Erforderliche Scopes: documents:write

Anfrage

Produktions-URL: https://public-api.cloudprint.me/api/v1/documents

Parameter

NamePositionTypErforderlichBeschreibungEinschränkungen
X-Request-IdheaderstringneinOptionale Kennung zur Anfrageverfolgung; CloudPrint gibt einen sicheren Wert im Antwort-Header zurück.maxLength: 128; example: "order-100045-attempt-1"

Anfrageinhalt

Inhaltstyp: multipart/form-data

NameTypErforderlichBeschreibungEinschränkungen
filestring (binary)jaBinäres PDF- oder RAW-Dokument als Multipart-Formulardaten.
document_formatstring | nullneinExplizites Druckformat, beispielsweise pdf oder raw.enum: pdf, raw; example: "raw"
document_raw_languagestring | nullneinDruckerbefehlssprache der RAW-Daten, beispielsweise ZPL oder EPL.enum: tspl, zpl, cpcl, escpos; example: "zpl"

Anfragebeispiele

cURL

bash
curl -sS https://public-api.cloudprint.me/api/v1/documents \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -F "file=@shipping-label.pdf"

Antwort

HTTP-Status: 201 — Ressource erstellt.

Antwortfelder

NameTypErforderlichBeschreibungEinschränkungen
document_idstring (uuid)jaStabile UUID, die nach einem erfolgreichen Dokument-Upload zurückgegeben wird.
original_filenamestringjaBeim Upload gespeicherter ursprünglicher Dateiname.example: "invoice.pdf"
mime_typestringjaMIME-Typ der veröffentlichten Installationsdatei oder des gespeicherten Dokuments.example: "application/pdf"
document_formatstringjaExplizites Druckformat, beispielsweise pdf oder raw.enum: pdf, raw; example: "pdf"
document_raw_languagestring | nulljaDruckerbefehlssprache der RAW-Daten, beispielsweise ZPL oder EPL.enum: tspl, zpl, cpcl, escpos; example: null
size_bytesintegerjaGröße des gespeicherten Dokuments in Byte.example: 1024

Beispielantwort

json
{
  "document_id": "11111111-1111-4111-8111-111111111111",
  "original_filename": "invoice.pdf",
  "mime_type": "application/pdf",
  "document_format": "pdf",
  "document_raw_language": null,
  "size_bytes": 1024
}

Fehler

HTTP-StatusBeschreibung
400Prüfen Sie Format und Parameter.
401Authentifizierung fehlt oder ist ungültig.
403Das Token hat nicht die erforderlichen Berechtigungen.
413Der Anfrageinhalt überschreitet die zulässige Größe.
415Das Format wird nicht unterstützt.
422Mindestens ein Feld ist ungültig.
429Anfragelimit überschritten; beachten Sie Retry-After.
500Interner CloudPrint-Fehler.

Hinweise zur Integration

  • PDF ist der Standard. Senden Sie für RAW ausdrücklich document_format=raw und document_raw_language.
  • Konvertieren Sie DOC und DOCX vor dem Upload im Backend in ein druckfertiges PDF.
  • Speichern Sie die document_id für den Druckauftrag.

Verwandte Dokumentation

Anleitungen zur CloudPrint-Integration, zur Verbindung des lokalen Agenten und zum zuverlässigen Betrieb von Druckabläufen.