Получить идентификаторы текущего пользователя

Порядок работы для агента · Методы API и схема OpenAPI.

НазначениеНазначение

Вызовите этот метод первым при проверке доступа на тестовом стенде. Он показывает, под какой учётной записью выполнен запрос. Для проверки профиля сотрудника нужен отдельный вызов, а для бизнес-операции — отдельная проверка прав.

Метод: GET /api/user/getYaId/v0

ДоступДоступ

Для вызова нужна аутентификация. Метод работает в пределах текущей учётной записи и не требует роли организации или отдельных прав.

Входные данныеВходные данные

Отправьте GET-запрос без тела и параметров.

РезультатРезультат

emailId — идентификатор почтовой учётной записи, связанной с запросом.

yaId — идентификатор Яндекс ID той же учётной записи.

Успешный ответ подтверждает аутентификацию для этого вызова. Если для сценария нужна роль сотрудника, продолжите с GET /api/users/userEmployees/get/list/v0.

Что сообщить пользователюЧто сообщить пользователю

Укажите стенд и сообщите, подтвердилась ли аутентификация. При ошибке сообщите HTTP-статус, если он получен. Токен, идентификаторы и тела запроса и ответа оставьте в клиенте.

Повтор запросаПовтор запроса

Метод только читает данные. Ограничивайте число повторов и повторяйте запрос только после временных сетевых ошибок или ошибок сервера. После сбоя аутентификации или настройки дождитесь, пока пользователь восстановит доступ.

Работа с чувствительными даннымиРабота с чувствительными данными

Метод возвращает идентификаторы учётной записи. Раскрывайте исходное значение только по явному запросу, при подтверждённой необходимости и с действующим доступом. Выбирайте минимум полей. Исключите исходные идентификаторы из журналов, трассировок, метрик, диагностики, обычного контекста ИИ и примеров.

Проверенные примерыПроверенные примеры

Используйте пример для проверки формата без отправки запроса в рабочий сервис.

Аутентифицированная синтетическая учётная запись · синтетический пример

Оба идентификатора созданы только для документации и не принадлежат реальному пользователю.

Сокращённый ответ

{
  "data": {
    "emailId": "email-id-example",
    "yaId": "yandex-id-example"
  }
}

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

RequestRequest

https://partner-test-yamagistrali.ru/api/user/getYaId/v0

ResponsesResponses

{
  "data": {
    "emailId": "example",
    "yaId": "example"
  }
}

{
  "emailId": "example",
  "yaId": "example"
}

{
  "emailId": "example",
  "yaId": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}

{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

{
  "info": {},
  "message": "example",
  "message_code": "example"
}