Saltar al contenido

Listar impresoras disponibles

Consulta las impresoras visibles mediante agentes conectados y elige un ID de impresora estable para la integración.

GET/api/v1/printersVersión de la API: v1operationId: listPrintersVer como Markdown

Qué hace este método

Consulta las impresoras visibles mediante agentes conectados y elige un ID de impresora estable para la integración.

Autenticación

Envía un token de corta duración en Authorization: Bearer <access_token>.

Permisos necesarios: printers:read

Solicitud

URL de producción: https://public-api.cloudprint.me/api/v1/printers

Parámetros

NombreUbicaciónTipoObligatorioDescripciónRestricciones
limitqueryintegernoNúmero máximo de recursos que se devuelven en una página.min: 1; max: 100; default: 100
cursorquerystring | nullnoCursor opaco de la página solicitada; envíalo de nuevo sin modificarlo.
X-Request-IdheaderstringnoIdentificador opcional para rastrear la solicitud; CloudPrint devuelve un valor seguro en la cabecera de respuesta.maxLength: 128; example: "order-100045-attempt-1"

Cuerpo de la solicitud

El método no tiene cuerpo de solicitud.

Ejemplos de solicitud

cURL

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

Respuesta

Estado HTTP: 200 — Solicitud completada.

Campos de respuesta

NombreTipoObligatorioDescripciónRestricciones
printersarrayImpresoras detectadas por los agentes conectados a la cuenta actual.
next_cursorstring | nullCursor opaco de la página siguiente; envíalo de nuevo sin modificarlo.

Ejemplo de respuesta

json
{
  "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
        }
      }
    }
  ],
  "next_cursor": "string"
}

Errores

Estado HTTPDescripción
401Falta la autenticación o no es válida.
403El token no tiene permisos suficientes.
422Uno o varios campos no son válidos.
429Se superó el límite de solicitudes; respeta Retry-After.
500Error interno de CloudPrint.

Recomendaciones de integración

  • Guarda printer_id; el nombre de la cola local puede cambiar.
  • Comprueba el estado, las capacidades y los datos de conexión antes de ofrecer RAW, impresión dúplex, color, tamaño o DPI.

Documentación relacionada

Guías para integrar CloudPrint, conectar el agente local y operar flujos de impresión.