Перейти к содержанию

Изменить состояние управляемого клиента

Приостановите, возобновите или навсегда закройте отношения с клиентом партнёрского приложения.

POST/partner-api/v1/accounts/{relationshipId}/{action}Версия API: v1operationId: changePartnerManagedAccountStateОткрыть в Markdown

Назначение метода

Приостановите, возобновите или навсегда закройте отношения с клиентом партнёрского приложения.

Авторизация

Передавайте одноразовый RS256 assertion Developer Application в Authorization: Bearer <application_assertion>. Это не токен доступа к Public API.

Запрос

Основной адрес API: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/{action}

Параметры

ИмяРасположениеТипОбязательноОписаниеОграничения
relationshipIdpathstring (uuid)даПоле контракта API; учитывайте указанные тип и ограничения.
actionpathstringдаПоле контракта API; учитывайте указанные тип и ограничения.enum: suspend, resume, close

Тело запроса

У метода нет тела запроса.

Примеры запросов

cURL

bash
curl -sS -X POST "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/suspend" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Ответ

HTTP-статус: 200 — Запрос выполнен.

Поля ответа

ИмяТипОбязательноОписаниеОграничения
relationship_idstring (uuid)даСтабильный идентификатор этого ресурса.
developer_account_idstring (uuid)даСтабильный идентификатор этого ресурса.
cloudprint_account_idstring (uuid)даСтабильный идентификатор этого ресурса.
external_customer_idstringдаСтабильный идентификатор этого ресурса.maxLength: 160
namestringдаПоле контракта API; учитывайте указанные тип и ограничения.maxLength: 120
application_idstring (uuid)даСтабильный идентификатор Developer Application, представленного токеном установки.
installation_idstring | null (uuid)даСтабильный UUID App Installation, выдавшей разрешение токену.
agent_enrollment_idstring | null (uuid)даСтабильный идентификатор этого ресурса.
agent_onboarding_expires_atstring | null (date-time)даВременная метка CloudPrint в формате ISO 8601.
agent_onboarding_urlstring | null (uri)даПоле контракта API; учитывайте указанные тип и ограничения.example: "https://connect.cloudprint.me/setup#token=cpat_example"
onboarding_statusstringдаПоле контракта API; учитывайте указанные тип и ограничения.enum: provisioning, waiting_for_agent, ready, failed
statusstringдаТекущее состояние ресурса или процесса; учитывайте допустимые значения конкретного метода.enum: provisioning, active, suspended, closed
created_atstring (date-time)даВременная метка CloudPrint в формате ISO 8601.
updated_atstring (date-time)даВременная метка CloudPrint в формате ISO 8601.

Пример ответа

json
{
  "relationship_id": "11111111-1111-4111-8111-111111111111",
  "developer_account_id": "11111111-1111-4111-8111-111111111111",
  "cloudprint_account_id": "11111111-1111-4111-8111-111111111111",
  "external_customer_id": "string",
  "name": "string",
  "application_id": "11111111-1111-4111-8111-111111111111",
  "installation_id": null,
  "agent_enrollment_id": null,
  "agent_onboarding_expires_at": null,
  "agent_onboarding_url": "https://connect.cloudprint.me/setup#token=cpat_example",
  "onboarding_status": "provisioning",
  "status": "provisioning",
  "created_at": "2026-08-06T12:00:00Z",
  "updated_at": "2026-08-06T12:00:00Z"
}

Ошибки

HTTP-статусОписание
401Авторизация отсутствует или недействительна.
403Для операции недостаточно разрешений.
404Запрошенный ресурс не найден.
422Поля запроса не прошли проверку.
429Превышен лимит запросов; учитывайте Retry-After.
500Внутренняя ошибка CloudPrint.

Рекомендации по интеграции

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

Руководства по интеграции CloudPrint, подключению локального агента и надёжной работе печати.