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

Получить один Agent Enrollment

Проверьте конкретное одноразовое подключение управляемого клиента и свяжите его с подключённым Agent.

GET/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}Версия API: v1operationId: getPartnerAgentEnrollmentОткрыть в Markdown

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

Проверьте конкретное одноразовое подключение управляемого клиента и свяжите его с подключённым Agent.

Авторизация

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

Запрос

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

Параметры

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

Тело запроса

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

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

cURL

bash
curl -sS \
  "https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments/$ENROLLMENT_ID" \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Ответ

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

Поля ответа

ИмяТипОбязательноОписаниеОграничения
agent_enrollment_idstring (uuid)даСтабильный идентификатор этого ресурса.
namestringдаПоле контракта API; учитывайте указанные тип и ограничения.
statusstringдаТекущее состояние ресурса или процесса; учитывайте допустимые значения конкретного метода.enum: pending, claimed, expired, revoked
expires_atstring (date-time)даВременная метка CloudPrint в формате ISO 8601.
created_atstring (date-time)даВременная метка CloudPrint в формате ISO 8601.
agent_idstring | null (uuid)даСтабильный UUID подключённого агента CloudPrint.
claimed_atstring | null (date-time)даВременная метка CloudPrint в формате ISO 8601.
revoked_atstring | null (date-time)даВременная метка CloudPrint в формате ISO 8601.

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

json
{
  "agent_enrollment_id": "11111111-1111-4111-8111-111111111111",
  "name": "string",
  "status": "pending",
  "expires_at": "2026-08-06T12:00:00Z",
  "created_at": "2026-08-06T12:00:00Z",
  "agent_id": null,
  "claimed_at": null,
  "revoked_at": null
}

Ошибки

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

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

  • Сохраняйте enrollment_id при создании ссылки и проверяйте именно этот ресурс; не определяйте завершение по другому Agent, ранее подключённому к аккаунту.
  • Статус ready означает успешное подключение — сохраните возвращённый agent_id. Прекратите проверку при expired, cancelled или failed.

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

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