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

Получить контекст API-клиента

Проверьте, к какому аккаунту и API-приложению относится текущий токен и какие разрешения ему выданы.

GET/api/v1/meВерсия API: v1operationId: getApiClientContextОткрыть в Markdown

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

Проверьте, к какому аккаунту и API-приложению относится текущий токен и какие разрешения ему выданы.

Авторизация

Передавайте короткоживущий токен в Authorization: Bearer <access_token>.

Подходит любой действующий токен доступа CloudPrint; дополнительные разрешения не требуются.

Запрос

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

Параметры

У метода нет параметров пути, строки запроса или дополнительных заголовков.

Тело запроса

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

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

cURL

bash
curl -sS https://public-api.cloudprint.me/api/v1/me \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Ответ

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

Поля ответа

ИмяТипОбязательноОписаниеОграничения
account_idstring (uuid)даСтабильный UUID аккаунта CloudPrint, которому принадлежит ресурс.
account_namestringдаОтображаемое имя аккаунта CloudPrint.example: "Acme Print Ops"
client_app_idstring | null (uuid)нетСтабильный идентификатор API Credentials, представленных текущим токеном.
client_app_namestring | nullнетНазвание API Credentials, используемое при диагностике аккаунта.
application_idstring | null (uuid)нетСтабильный идентификатор Developer Application, представленного токеном установки.
application_namestring | nullнетНазвание Developer Application, видимое операторам аккаунта.
authorization_modestringдаМодель авторизации токена: данные доступа аккаунта или установка приложения.enum: client_credentials, app_installation
installation_idstring | null (uuid)даСтабильный UUID App Installation, выдавшей разрешение токену.
scopesarrayнетРазрешения, выданные текущему токену доступа.example: ["agents:read","printers:read","documents:write","print_jobs:write","print_jobs:read"]
permissionsarrayнетРазрешения установки, включённые в этот токен.

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

json
{
  "account_id": "11111111-1111-4111-8111-111111111111",
  "account_name": "Acme Print Ops",
  "client_app_id": null,
  "client_app_name": null,
  "application_id": null,
  "application_name": null,
  "authorization_mode": "client_credentials",
  "installation_id": null,
  "scopes": [
    "agents:read",
    "printers:read",
    "documents:write",
    "print_jobs:write",
    "print_jobs:read"
  ],
  "permissions": [
    "string"
  ]
}

Ошибки

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

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

  • Используйте эту проверку при подключении и диагностике, чтобы подтвердить аккаунт и выданные разрешения.
  • Не вызывайте метод перед каждым бизнес-запросом: токен уже содержит контекст клиента.

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

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