Справочник CloudPrint API v1
Версионированная документация CloudPrint API по авторизации, принтерам, документам, заданиям, ошибкам и безопасным повторам.
Как пользоваться документацией
Быстрый старт и руководства по сценариям объясняют весь бизнес-процесс. Версионированный справочник API нужен для точной реализации запросов, полей, ответов и обработки ошибок. Интерактивный обозреватель остаётся вспомогательным инструментом; каждая публичная операция доступна в статическом HTML и Markdown.
Основной адрес и последовательность запросов
Рабочие запросы отправляются на https://public-api.cloudprint.me. Обычная интеграция получает токен, выбирает принтер, загружает документ, создаёт идемпотентное задание и проверяет его до конечного статуса.
Гарантии совместимости
Основная версия входит в стабильный путь API. В v1 могут появляться совместимые дополнения; удаление или переименование операций и полей требует новой основной версии.
Что делает CloudPrint
CloudPrint доставляет готовый PDF или явные RAW-команды языка принтера на выбранный локальный принтер через исходящее соединение агента. Public API не создаёт этикетки перевозчика, не конвертирует документы Office и не раскрывает внутренний протокол агента.
Все операции API v1
| Тип | Описание | Путь |
|---|---|---|
POST | Получение токена | /oauth/token |
POST | Токен установки | /developer-api/v1/app-installations/{installationId}/access-tokens |
GET | Версии Agent | /agent-download-api/v1/releases |
GET | Скачивание Agent | /agent-download-api/v1/installers/{filename} |
GET | Список аккаунтов клиентов | /partner-api/v1/accounts |
POST | Создание аккаунта | /partner-api/v1/accounts |
GET | Получение аккаунта | /partner-api/v1/accounts/{relationshipId} |
GET | Список Agent Enrollments | /partner-api/v1/accounts/{relationshipId}/agent-enrollments |
POST | Создание Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments |
GET | Получение Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId} |
DELETE | Отзыв Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId} |
GET | Список Agents клиента | /partner-api/v1/accounts/{relationshipId}/agents |
DELETE | Отзыв Agent клиента | /partner-api/v1/accounts/{relationshipId}/agents/{agentId} |
GET | Usage партнёра | /partner-api/v1/usage |
POST | Состояние аккаунта | /partner-api/v1/accounts/{relationshipId}/{action} |
GET | Контекст клиента | /api/v1/me |
GET | Список агентов | /api/v1/agents |
GET | Список принтеров | /api/v1/printers |
POST | Загрузка документа | /api/v1/documents |
GET | Список заданий | /api/v1/print-jobs |
POST | Создание задания | /api/v1/print-jobs |
POST | Создание из URL | /api/v1/print-jobs/from-url |
POST | Создание из Base64 | /api/v1/print-jobs/from-base64 |
GET | Статус задания | /api/v1/print-jobs/{printJobId} |