Справочник CloudPrint API v1
Версионированная документация CloudPrint API по авторизации, принтерам, документам, заданиям, ошибкам и безопасным повторам.
Как пользоваться документацией
В быстром старте и тематических руководствах показан весь процесс печати. В справочнике API v1 приведены точные запросы, поля, ответы и ошибки. Интерактивный просмотр удобен для знакомства со схемой, но каждая публичная операция также доступна в статическом HTML и Markdown.
Основной адрес и официальное зеркало
Основной адрес — https://public-api.cloudprint.me. Если он недоступен из сети, используйте https://public-api.cloudprint.by для OAuth, Print API, Developer API, Partner API и загрузки CloudPrint Agent. Меняйте только имя хоста, сохраняя путь и остальные части запроса. Выбирайте базовый адрес до отправки запроса; для операций с Idempotency-Key повтор после неопределённого результата должен сохранять исходные данные и тот же ключ. Оба адреса обслуживают один контракт и не выбирают регион хранения данных. В RS256-подтверждениях оставляйте точное каноническое значение aud из документации метода, даже когда HTTP-запрос отправляется через зеркало.
Основная последовательность запросов
Обычная интеграция получает токен, выбирает принтер, загружает документ, создаёт задание с защитой от дублей и проверяет его до итогового статуса.
Гарантии совместимости
Основная версия входит в стабильный путь 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-download-api/v1/releases |
GET | Скачивание агента | /agent-download-api/v1/installers/{filename} |
GET | Список аккаунтов клиентов | /partner-api/v1/accounts |
POST | Создание аккаунта | /partner-api/v1/accounts |
GET | Получение аккаунта | /partner-api/v1/accounts/{relationshipId} |
GET | Список Agent Enrollment | /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 | Список агентов клиента | /partner-api/v1/accounts/{relationshipId}/agents |
DELETE | Отзыв агента клиента | /partner-api/v1/accounts/{relationshipId}/agents/{agentId} |
GET | Статистика аккаунтов | /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} |