Доступ к API

Здесь вы найдёте информацию о стендах, способах авторизации, получении токенов и диагностике.

СтендыСтенды

OpenAPIOpenAPI

Актуальная спецификация API доступна по ссылке:

OpenAPI (Прод)

Для тестирования и разработки используйте:

OpenAPI (Тест)

На странице OpenAPI нажмите кнопку Authorize, чтобы авторизоваться и использовать API прямо в браузере.

Авторизация и токеныАвторизация и токены

Все запросы к API требуют передачи токена в заголовке:

Authorization: Bearer ваш_токен

Автоматический способ (рекомендуется для разработки)Автоматический способ (рекомендуется для разработки)

Откройте браузер и перейдите по ссылке

• Прод:
  https://yamagistrali.ru

• Тест:
  https://partner-test-yamagistrali.ru

После входа в аккаунт Яндекс ID вы будете перенаправлены на страницу с токеном.

Авторизация через OpenAPIАвторизация через OpenAPI

1. Перейдите на:
   • Прод: https://yamagistrali.ru/openapi/
   • Тест: https://partner-test-yamagistrali.ru/openapi/
2. Нажмите кнопку Authorize
3. Войдите под нужным аккаунтом
4. Токен будет автоматически применён ко всем вызовам

Ручной способ (только для тестов)Ручной способ (только для тестов)

Как получить токенКак получить токен

1. Войдите в систему через браузер под нужным аккаунтом.
2. Откройте инструменты разработчика (F12).
3. Перейдите во вкладку Application → Cookies.
4. Найдите куку с именем YToken.
5. Скопируйте её значение — это и есть ваш токен.

Рекомендуется регулярно обновлять токен и не хранить в открытом виде.

Сайт и APIСайт и API

Сайт использует то же API, что и внешние интеграции. Это позволяет:

• Анализировать поведение системы через сетевые вызовы в DevTools
• Понимать формат запросов и ответов
• Отлаживать интеграции "по аналогии" с веб-интерфейсом

Как смотреть вызовыКак смотреть вызовы

1. Откройте сайт в браузере
2. Нажмите F12 → вкладка Network
3. Выполните нужное действие (например, создание заказа)
4. Найдите соответствующий XHR/Fetch запрос
5. Изучите:
   • URL
   • Заголовки (включая Authorization)
   • Тело запроса и ответа

Как понять, под кем вы работаетеКак понять, под кем вы работаете

Для стабильной и безопасной работы важно знать:

• Какой пользователь авторизован
• Под каким сотрудником выполняются действия

1. Определение пользователя1. Определение пользователя

Вызовите метод:

GET /api/user/getYaId/v0

В ответе проверьте заголовок:

X-Email-Id: user@example.com

Это ваш логин в Яндекс.Магистралях.

2. Определение сотрудника2. Определение сотрудника

Вызовите метод:

GET /api/users/userEmployees/get/list/v0

В ответе вы получите список сотрудников, от имени которых вы можете действовать:

[
    {
        "id": "emp-123",
        "name": "Иван Иванов",
        "role": "agent",
        "active": true
    }
]

Убедитесь, что вы работаете от имени нужного сотрудника. Некоторые операции доступны только определённым ролям.