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

Name	Position	Typ	Erforderlich	Beschreibung	Einschränkungen
`X-Request-Id`	header	`string`	nein	Optionale 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

Name	Typ	Erforderlich	Beschreibung	Einschränkungen
`file`	`string (binary)`	ja	Binäres PDF- oder RAW-Dokument als Multipart-Formulardaten.	—
`document_format`	`string \| null`	nein	Explizites Druckformat, beispielsweise `pdf` oder `raw`. Beide Formate verwenden `documents:write`.	enum: `pdf`, `raw`; example: `"raw"`
`document_raw_language`	`string \| null`	nein	Druckerbefehlssprache der RAW-Daten, beispielsweise ZPL oder TSPL.	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

Name	Typ	Erforderlich	Beschreibung	Einschränkungen
`document_id`	`string (uuid)`	ja	Stabile UUID, die nach einem erfolgreichen Dokument-Upload zurückgegeben wird.	—
`original_filename`	`string`	ja	Beim Upload gespeicherter ursprünglicher Dateiname.	example: `"invoice.pdf"`
`mime_type`	`string`	ja	MIME-Typ der veröffentlichten Installationsdatei oder des gespeicherten Dokuments.	example: `"application/pdf"`
`document_format`	`string`	ja	Explizites Druckformat, beispielsweise `pdf` oder `raw`. Beide Formate verwenden `documents:write`.	enum: `pdf`, `raw`; example: `"pdf"`
`document_raw_language`	`string \| null`	ja	Druckerbefehlssprache der RAW-Daten, beispielsweise ZPL oder TSPL.	enum: `tspl`, `zpl`, `cpcl`, `escpos`; example: `null`
`size_bytes`	`integer`	ja	Größ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-Status	Beschreibung
`400`	Prüfen Sie Format und Parameter.
`401`	Authentifizierung fehlt oder ist ungültig.
`403`	Das Token hat nicht die erforderlichen Berechtigungen.
`413`	Der Anfrageinhalt überschreitet die zulässige Größe.
`415`	Das Format wird nicht unterstützt.
`422`	Mindestens ein Feld ist ungültig.
`429`	Anfragelimit überschritten; beachten Sie Retry-After.
`500`	Interner CloudPrint-Fehler.
`503`	Dienst vorübergehend nicht verfügbar.

Hinweise zur Integration

Die bestehende Berechtigung documents:write gilt für PDF und RAW. 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.
Korrigieren Sie das Dokument nach 422; wiederholen Sie einen vorübergehenden Prüfungsfehler 503 mit begrenztem, wachsendem Abstand.
Speichern Sie die document_id für den Druckauftrag.

Dokument zum Drucken hochladen ​

Funktion dieser Methode ​

Authentifizierung ​

Anfrage ​

Parameter ​

Anfrageinhalt ​

Anfragebeispiele ​

cURL ​

Antwort ​

Antwortfelder ​

Beispielantwort ​

Fehler ​

Hinweise zur Integration ​

Verwandte Dokumentation ​