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

Получить usage Partner Program

Получите managed accounts, active Agents и print jobs за один календарный месяц UTC.

GET/partner-api/v1/usageВерсия API: v1operationId: getPartnerUsageОткрыть в Markdown

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

Получите managed accounts, active Agents и print jobs за один календарный месяц UTC.

Авторизация

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

Запрос

Основной адрес API: https://public-api.cloudprint.me/partner-api/v1/usage

Параметры

ИмяРасположениеТипОбязательноОписаниеОграничения
periodquerystringнетПоле контракта API; учитывайте указанные тип и ограничения.example: "2026-08"

Тело запроса

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

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

cURL

bash
curl -sS 'https://public-api.cloudprint.me/partner-api/v1/usage?period=2026-08' \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Ответ

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

Поля ответа

ИмяТипОбязательноОписаниеОграничения
periodstringдаПоле контракта API; учитывайте указанные тип и ограничения.
starts_atstring (date-time)даВременная метка CloudPrint в формате ISO 8601.
ends_atstring (date-time)даВременная метка CloudPrint в формате ISO 8601.
managed_accountsintegerдаПоле контракта API; учитывайте указанные тип и ограничения.min: 0
active_agentsintegerдаПоле контракта API; учитывайте указанные тип и ограничения.min: 0
print_jobsintegerдаЗадания печати текущего аккаунта с учётом фильтров.min: 0

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

json
{
  "period": "string",
  "starts_at": "2026-08-06T12:00:00Z",
  "ends_at": "2026-08-06T12:00:00Z",
  "managed_accounts": 0,
  "active_agents": 0,
  "print_jobs": 0
}

Ошибки

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

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

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

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