Dokumentacja CloudPrint/Dokumentacja API

Pobierz listę dostępnych drukarek

Pobierz drukarki widoczne przez agentów CloudPrint i wybierz stabilny printer_id dla procesu.

GET/api/v1/printersWersja API: v1operationId: listPrintersOtwórz w Markdown

Działanie metody

Pobierz drukarki widoczne przez agentów CloudPrint i wybierz stabilny printer_id dla procesu.

Uwierzytelnianie

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

Wymagane uprawnienia: printers:read

Żądanie

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

Parametry

Nazwa	Położenie	Typ	Wymagane	Opis	Ograniczenia
limit	query	integer	nie	Maksymalna liczba zasobów zwracanych na jednej stronie.	min: 1; max: 100; default: 100
cursor	query	string | null	nie	Nieprzezroczysty kursor strony wyników; przekazuj go bez zmian.	—
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

Metoda nie ma treści żądania.

Przykładowe żądania

cURL

curl -sS 'https://public-api.cloudprint.me/api/v1/printers?limit=100' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Odpowiedź

Status HTTP: 200 — Żądanie zostało wykonane.

Pola odpowiedzi

Nazwa	Typ	Wymagane	Opis	Ograniczenia
printers	array	tak	Drukarki wykryte przez agentów połączonych z bieżącym kontem.	—
next_cursor	string | null	tak	Nieprzezroczysty kursor następnej strony; przekaż go bez zmian.	—

Przykładowa odpowiedź

{
  "printers": [
    {
      "printer_id": "11111111-1111-4111-8111-111111111111",
      "agent_id": "11111111-1111-4111-8111-111111111111",
      "local_identifier": "zebra-zd421-usb-001",
      "name": "Warehouse Label Printer",
      "status": "online",
      "last_seen_at": "2026-08-06T12:00:00Z",
      "agent_name": "Warehouse PC agent",
      "agent_hostname": "warehouse-pc",
      "agent_status": "online",
      "agent_last_seen_at": "2026-08-06T12:00:00Z",
      "capabilities": {
        "backend": "windows_native",
        "language_profiles": [
          {
            "language": "zpl",
            "version": "zpl2",
            "supported_commands": [
              "gf"
            ],
            "max_bitmap_width_dots": 812,
            "max_bitmap_height_dots": 1199,
            "compression_modes": [
              "ascii-hex"
            ],
            "codepage": "utf-8"
          }
        ],
        "supports_custom_media": true,
        "supports_orientation": true,
        "supports_copies": true,
        "supports_duplex": true,
        "supports_color": true,
        "supports_scaling": true,
        "supports_offsets": true,
        "supports_printable_area": true,
        "supported_dpi": [
          1
        ],
        "supported_media_sizes": [
          {
            "width_mm": 0,
            "height_mm": 0
          }
        ],
        "supported_feed_types": [
          "gap"
        ],
        "darkness_min": 0,
        "darkness_max": 30,
        "speed_min": 1,
        "speed_max": 14
      },
      "endpoint": {
        "system_print_available": true,
        "raw_passthrough_available": true,
        "configuration_issue": "interactive_output_port",
        "os": "linux",
        "driver_name": "CUPS",
        "port_name": "ipp://printer.local/ipp/print",
        "print_processor": "cups",
        "data_type": "RAW",
        "connection_type": "cups",
        "default_media_profile_id": "string",
        "default_media_profile": {
          "width_mm": 100,
          "height_mm": 150,
          "dpi": 203,
          "orientation": "default",
          "feed_type": "gap",
          "darkness": 15,
          "speed": 4
        }
      },
      "status_evidence": {
        "source": "unknown",
        "reasons": [
          "configured_offline"
        ]
      }
    }
  ],
  "next_cursor": "string"
}

Błędy

Status HTTP	Opis
401	Brak uwierzytelnienia albo jest ono nieprawidłowe.
403	Brak uprawnień wymaganych do tej operacji.
422	Pola żądania nie przeszły walidacji.
429	Przekroczono limit żądań; zastosuj Retry-After.
500	Wewnętrzny błąd CloudPrint.

Wskazówki integracyjne

• Zapisuj printer_id; lokalna nazwa kolejki służy do wyświetlania i może się zmienić.
• Sprawdź stan, możliwości i dane połączenia drukarki przed udostępnieniem druku RAW, trybu dwustronnego lub kolorowego, rozmiaru nośnika albo DPI.

Powiązana dokumentacja

Połączenie agenta i wybór drukarkiZainstaluj agenta CloudPrint, wykryj lokalne kolejki i zapisz stabilny printer_id zgodny z możliwościami drukarki.Prześlij dokument do drukuPrześlij gotowy PDF lub jawne dane RAW języka drukarki przed utworzeniem zadania CloudPrint.Utwórz zadanie drukuWyślij przesłany dokument CloudPrint na wybraną drukarkę z idempotencją i jawnymi opcjami.

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