Получить список доступных принтеров
Получите принтеры подключённых агентов CloudPrint и выберите стабильный printer_id для сценария печати.
Назначение метода
Получите принтеры подключённых агентов CloudPrint и выберите стабильный printer_id для сценария печати.
Авторизация
Передавайте короткоживущий токен в Authorization: Bearer <access_token>.
Обязательные разрешения: printers:read
Запрос
Основной адрес API: https://public-api.cloudprint.me/api/v1/printers
Параметры
| Имя | Расположение | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|---|
limit | query | integer | нет | Максимальное количество ресурсов на одной странице. | min: 1; max: 100; default: 100 |
cursor | query | string | null | нет | Непрозрачный курсор страницы результатов; передавайте его без изменений. | — |
X-Request-Id | header | string | нет | Необязательный идентификатор для трассировки запроса; CloudPrint вернёт безопасное значение в заголовке ответа. | maxLength: 128; example: "order-100045-attempt-1" |
Тело запроса
У метода нет тела запроса.
Примеры запросов
cURL
bash
curl -sS 'https://public-api.cloudprint.me/api/v1/printers?limit=100' \
-H "Authorization: Bearer $ACCESS_TOKEN"Ответ
HTTP-статус: 200 — Запрос выполнен.
Поля ответа
| Имя | Тип | Обязательно | Описание | Ограничения |
|---|---|---|---|---|
printers | array | да | Принтеры, обнаруженные агентами текущего аккаунта. | — |
next_cursor | string | null | да | Непрозрачный cursor следующей страницы; передавайте его без изменений. | — |
Пример ответа
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
}
},
"status_evidence": {
"source": "unknown",
"reasons": [
"configured_offline"
]
}
}
],
"next_cursor": "string"
}Ошибки
| HTTP-статус | Описание |
|---|---|
401 | Авторизация отсутствует или недействительна. |
403 | Для операции недостаточно разрешений. |
422 | Поля запроса не прошли проверку. |
429 | Превышен лимит запросов; учитывайте Retry-After. |
500 | Внутренняя ошибка CloudPrint. |
Рекомендации по интеграции
- Сохраняйте
printer_id: локальное имя очереди предназначено для отображения и может измениться. - Проверяйте состояние, возможности и данные подключения принтера, прежде чем предлагать RAW-печать, двусторонний или цветной режим, размер носителя либо DPI.
Связанная документация
Local Printer API для веб-приложений и SaaSПодключите сервер веб-приложения к локальным принтерам через CloudPrint Agent, получите очереди через API и маршрутизируйте по стабильному printer_id.Загрузить документ для печатиЗагрузите готовый PDF или явные RAW-команды языка принтера перед созданием задания CloudPrint.Создать задание печатиОтправьте загруженный документ CloudPrint на выбранный принтер с идемпотентностью и явными параметрами.