Dokumentacja CloudPrint/Dokumentacja API

Prześlij dokument do druku

Prześlij gotowy PDF lub jawne dane RAW języka drukarki przed utworzeniem zadania CloudPrint.

POST/api/v1/documentsWersja API: v1operationId: uploadDocumentOtwórz w Markdown

Działanie metody

Prześlij gotowy PDF lub jawne dane RAW języka drukarki przed utworzeniem zadania CloudPrint.

Uwierzytelnianie

Przekaż krótkotrwały token w Authorization: Bearer <access_token>.

Wymagane uprawnienia: documents:write

Żądanie

Podstawowy adres API: https://public-api.cloudprint.me/api/v1/documents

Parametry

Nazwa	Położenie	Typ	Wymagane	Opis	Ograniczenia
X-Request-Id	header	string	nie	Opcjonalny identyfikator do śledzenia żądania; CloudPrint zwróci bezpieczną wartość w nagłówku odpowiedzi.	maxLength: 128; example: "order-100045-attempt-1"

Treść żądania

Typ zawartości: multipart/form-data

Nazwa	Typ	Wymagane	Opis	Ograniczenia
file	string (binary)	tak	Binarny dokument PDF lub RAW przesyłany jako multipart form data.	—
document_format	string | null	nie	Jawny format druku, na przykład pdf albo raw. Oba formaty używają documents:write.	enum: pdf, raw; example: "raw"
document_raw_language	string | null	nie	Język poleceń danych RAW, na przykład ZPL lub TSPL.	enum: tspl, zpl, cpcl, escpos; example: "zpl"

Przykładowe żądania

cURL

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

Odpowiedź

Status HTTP: 201 — Zasób został utworzony.

Pola odpowiedzi

Nazwa	Typ	Wymagane	Opis	Ograniczenia
document_id	string (uuid)	tak	Stabilny UUID zwracany po pomyślnym przesłaniu dokumentu.	—
original_filename	string	tak	Oryginalna nazwa pliku zapisana podczas przesyłania dokumentu.	example: "invoice.pdf"
mime_type	string	tak	Typ MIME opublikowanego instalatora albo zapisanego dokumentu.	example: "application/pdf"
document_format	string	tak	Jawny format druku, na przykład pdf albo raw. Oba formaty używają documents:write.	enum: pdf, raw; example: "pdf"
document_raw_language	string | null	tak	Język poleceń danych RAW, na przykład ZPL lub TSPL.	enum: tspl, zpl, cpcl, escpos; example: null
size_bytes	integer	tak	Rozmiar zapisanego dokumentu w bajtach.	example: 1024

Przykładowa odpowiedź

{
  "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
}

Błędy

Status HTTP	Opis
400	Sprawdź format i parametry żądania.
401	Brak uwierzytelnienia albo jest ono nieprawidłowe.
403	Brak uprawnień wymaganych do tej operacji.
413	Treść żądania przekracza dozwolony rozmiar.
415	Format treści nie jest obsługiwany.
422	Pola żądania nie przeszły walidacji.
429	Przekroczono limit żądań; zastosuj Retry-After.
500	Wewnętrzny błąd CloudPrint.
503	Usługa jest tymczasowo niedostępna.

Wskazówki integracyjne

• Istniejące uprawnienie documents:write obejmuje PDF i RAW. Dla RAW jawnie wyślij document_format=raw i document_raw_language.
• Konwertuj DOC i DOCX do gotowego PDF po stronie serwera.
• Po odrzuceniu dokumentu z kodem 422 popraw dane; chwilowy błąd kontroli 503 ponów z ograniczonym, rosnącym opóźnieniem.
• Zapisz zwrócony document_id do żądania utworzenia zadania.

Powiązana dokumentacja

Przesyłanie dokumentów PDF i RAWWybierz multipart, publiczny adres HTTPS lub Base64 i przygotuj plik PDF albo dane RAW języka drukarki.Utwórz zadanie drukuWyślij przesłany dokument CloudPrint na wybraną drukarkę z idempotencją i jawnymi opcjami.Utwórz zadanie z adresu URLPobierz dokument z publicznego URL HTTPS i jednym żądaniem utwórz dokument oraz zadanie CloudPrint.

Status usługiOpenAPIDeveloper PortalOtwórz panelPolityka prywatnościRegulaminDPAService Level Agreement