---
title: "Справочник CloudPrint API v1"
description: "Версионированная документация CloudPrint API по авторизации, принтерам, документам, заданиям, ошибкам и безопасным повторам."
---
<nav class="docs-breadcrumb" aria-label="Breadcrumb"><a href="/docs/">Документация CloudPrint</a><span aria-hidden="true">/</span><span>Справочник API</span></nav>

# Справочник CloudPrint API v1

<p class="docs-lead">Версионированная документация CloudPrint API по авторизации, принтерам, документам, заданиям, ошибкам и безопасным повторам.</p>

<div class="api-reference-actions"><span><strong>Версия API:</strong> v1</span><a href="/docs/api/v1/openapi.json">Скачать OpenAPI v1 в формате JSON</a><a href="/docs/api/v1/explorer/">Открыть интерактивный справочник API</a><a href="/docs/api/v1/index.md">Открыть в Markdown</a></div>

## Как пользоваться документацией

Быстрый старт и руководства по сценариям объясняют весь бизнес-процесс. Версионированный справочник API нужен для точной реализации запросов, полей, ответов и обработки ошибок. Интерактивный обозреватель остаётся вспомогательным инструментом; каждая публичная операция доступна в статическом HTML и Markdown.

## Основной адрес и последовательность запросов

Рабочие запросы отправляются на `https://public-api.cloudprint.me`. Обычная интеграция получает токен, выбирает принтер, загружает документ, создаёт идемпотентное задание и проверяет его до конечного статуса.

## Гарантии совместимости

Основная версия входит в стабильный путь API. В `v1` могут появляться совместимые дополнения; удаление или переименование операций и полей требует новой основной версии.

## Что делает CloudPrint

CloudPrint доставляет готовый PDF или явные RAW-команды языка принтера на выбранный локальный принтер через исходящее соединение агента. Public API не создаёт этикетки перевозчика, не конвертирует документы Office и не раскрывает внутренний протокол агента.

## Все операции API v1
| Тип | Описание | Путь |
| --- | --- | --- |
| `POST` | [Получение токена](/docs/api/v1/authentication/token/) | `/oauth/token` |
| `POST` | [Токен установки](/docs/api/v1/app-installations/access-token/) | `/developer-api/v1/app-installations/{installationId}/access-tokens` |
| `GET` | [Версии Agent](/docs/api/v1/agent-downloads/releases/) | `/agent-download-api/v1/releases` |
| `GET` | [Скачивание Agent](/docs/api/v1/agent-downloads/installer/) | `/agent-download-api/v1/installers/{filename}` |
| `GET` | [Список аккаунтов клиентов](/docs/api/v1/partner/accounts/list/) | `/partner-api/v1/accounts` |
| `POST` | [Создание аккаунта](/docs/api/v1/partner/accounts/create/) | `/partner-api/v1/accounts` |
| `GET` | [Получение аккаунта](/docs/api/v1/partner/accounts/get/) | `/partner-api/v1/accounts/{relationshipId}` |
| `GET` | [Список Agent Enrollments](/docs/api/v1/partner/agent-enrollments/list/) | `/partner-api/v1/accounts/{relationshipId}/agent-enrollments` |
| `POST` | [Создание Agent Enrollment](/docs/api/v1/partner/agent-enrollments/create/) | `/partner-api/v1/accounts/{relationshipId}/agent-enrollments` |
| `GET` | [Получение Agent Enrollment](/docs/api/v1/partner/agent-enrollments/get/) | `/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}` |
| `DELETE` | [Отзыв Agent Enrollment](/docs/api/v1/partner/agent-enrollments/revoke/) | `/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}` |
| `GET` | [Список Agents клиента](/docs/api/v1/partner/agents/list/) | `/partner-api/v1/accounts/{relationshipId}/agents` |
| `DELETE` | [Отзыв Agent клиента](/docs/api/v1/partner/agents/revoke/) | `/partner-api/v1/accounts/{relationshipId}/agents/{agentId}` |
| `GET` | [Usage партнёра](/docs/api/v1/partner/usage/) | `/partner-api/v1/usage` |
| `POST` | [Состояние аккаунта](/docs/api/v1/partner/accounts/change-state/) | `/partner-api/v1/accounts/{relationshipId}/{action}` |
| `GET` | [Контекст клиента](/docs/api/v1/authentication/client-context/) | `/api/v1/me` |
| `GET` | [Список агентов](/docs/api/v1/agents/list/) | `/api/v1/agents` |
| `GET` | [Список принтеров](/docs/api/v1/printers/list/) | `/api/v1/printers` |
| `POST` | [Загрузка документа](/docs/api/v1/documents/upload/) | `/api/v1/documents` |
| `GET` | [Список заданий](/docs/api/v1/print-jobs/list/) | `/api/v1/print-jobs` |
| `POST` | [Создание задания](/docs/api/v1/print-jobs/create/) | `/api/v1/print-jobs` |
| `POST` | [Создание из URL](/docs/api/v1/print-jobs/create-from-url/) | `/api/v1/print-jobs/from-url` |
| `POST` | [Создание из Base64](/docs/api/v1/print-jobs/create-from-base64/) | `/api/v1/print-jobs/from-base64` |
| `GET` | [Статус задания](/docs/api/v1/print-jobs/get/) | `/api/v1/print-jobs/{printJobId}` |

## Связанная документация

<div class="docs-card-grid"><a class="docs-card" href="/docs/api/v1/authentication/token/"><strong>Получить токен доступа OAuth2</strong><span>Обменяйте данные доступа CloudPrint API на короткоживущий Bearer-токен OAuth2 по схеме Client Credentials.</span></a>
<a class="docs-card" href="/docs/api/v1/printers/list/"><strong>Получить список доступных принтеров</strong><span>Получите принтеры подключённых агентов CloudPrint и выберите стабильный printer_id для сценария печати.</span></a>
<a class="docs-card" href="/docs/api/v1/print-jobs/create/"><strong>Создать задание печати</strong><span>Отправьте загруженный документ CloudPrint на выбранный принтер с идемпотентностью и явными параметрами.</span></a></div>

<nav class="docs-resource-links" aria-label="Следующие шаги"><a href="/docs/api/v1/explorer/">OpenAPI</a><a href="https://my.cloudprint.by">Открыть кабинет</a><a href="/docs/legal/privacy/">Политика конфиденциальности</a><a href="/docs/legal/terms/">Условия использования</a><a href="/docs/legal/payments-and-refunds/">Оплата и возврат</a><a href="/docs/legal/data-processing/">DPA</a></nav>