Доступ к API

Для доступа к API Яндекс Вики можно использовать один из способов авторизации:

В запросах к API Яндекс Вики указывайте заголовки:

  • Host: api.wiki.yandex.net

  • Заголовок авторизации:

    • Authorization: OAuth <OAuth-токен> — при доступе по протоколу OAuth 2.0.

    • Authorization: Bearer <IAM-токен> — при доступе с помощью IAM-токена.

  • Идентификатор организации:

    • X-Org-Id — для организации Яндекс 360 для бизнеса.
    • X-Cloud-Org-Id — для организации Yandex Cloud Organization.

    Совет

    Чтобы узнать идентификатор организации, в сервисе Яндекс Трекер откройте страницу Администрирование → Организации и скопируйте значение поля идентификатор.

Пример:

Host: api.wiki.yandex.net
Authorization: Bearer t1.ab123cd45*****************
X-Org-Id: bpfv7***************

Получить доступ к API по протоколу OAuth

Для доступа к API Яндекс Вики требуется получить токен в сервисе OAuth. Токен предоставляет те же права, которые есть у аккаунта пользователя в Вики. Например, если у пользователя нет прав на редактирование страницы, соответствующие запросы к API будут недоступны.

Полученный токен используйте в заголовке Authorization в запросах к API Яндекс Вики.

С базовыми принципами OAuth, а также с особенностями реализации протокола в Яндексе вы можете ознакомиться в документации сервиса OAuth для Яндекс ID.

Настроить выдачу токенов для пользователей

Допустим, вы хотите интегрировать ваше приложение или систему с Вики. Например, чтобы система могла добавлять строки в таблицу с помощью API от имени пользователей вашей организации. Тогда для каждого пользователя системы нужно получать токен для доступа к API Яндекс Вики.

Чтобы настроить выдачу токенов для пользователей:

  1. Перейдите по ссылке https://oauth.yandex.ru/client/new/ и зарегистрируйте приложение в сервисе OAuth: см. раздел Регистрация приложения в Справке Яндекс ID.

  2. Чтобы выбрать разрешение, начните вводить его название в поле Название доступа:

    • Запись в Вики (wiki:write) — все операции с данными: создание, удаление, редактирование.

    • Чтение из Вики (wiki:read) — только чтение данных.

    Скриншот

  3. Выберите способ получения OAuth-токена и настройте его: см. раздел Получение OAuth-токена в Справке Яндекс ID.

Получить OAuth-токен

Если вам нужен доступ к API Яндекс Вики для тестирования, отладки или автоматизации, получите отладочный OAuth-токен:

  1. Перейдите по ссылке https://oauth.yandex.ru/client/new/.

  2. В разделе Платформы приложения выберите Веб-сервисы.

  3. Установите курсор в поле Redirect URI и в подсказке нажмите Подставить URL для отладки. В поле будет подставлено значение https://oauth.yandex.ru/verification_code.

  4. Чтобы выбрать разрешение, начните вводить его название в поле Название доступа:

    • Запись в Вики (wiki:write) — все операции с данными: создание, удаление, редактирование.

    • Чтение из Вики (wiki:read) — только чтение данных.

    Скриншот

  5. Чтобы получить отладочный токен:

    1. В личном кабинете Яндекс OAuth выберите созданное ранее приложение и скопируйте его идентификатор из поля ClientID.

    2. Затем сформируйте ссылку для запроса токена:

    https://oauth.yandex.ru/authorize?response_type=token&client_id=<идентификатор_приложения>
    1. Перейдите по ссылке и скопируйте OAuth-токен. Подробнее читайте в Справке Яндекс ID.

Чтобы проверить наличие доступа к API, выполните какой-либо запрос. Если доступ не был получен, запрос вернет ответ с кодом 401 Unauthorized.

Например, выполнить запрос информации о странице mypage с помощью curl:

curl -X GET 'https://api.wiki.yandex.net/v1/pages?slug=mypage' \
     -H 'Authorization: OAuth ABC-def12GH_******' \
     -H 'X-Org-Id: bpfv7***************'

curl -X GET "https://api.wiki.yandex.net/v1/pages?slug=mypage" ^
     -H "Authorization: OAuth ABC-def12GH_******" ^
     -H "X-Org-Id: bpfv7***************"

Получить доступ к API по IAM-токену

Если вы используете Вики в составе организации Yandex Cloud, для авторизации в API можно использовать IAM-токен.

IAM-токен — уникальная последовательность символов, которая выдается пользователю после прохождения аутентификации. С помощью этого токена пользователь авторизуется в API Яндекс Вики и выполняет операции с ресурсами. Подробнее об этом способе аутентификации читайте в документации сервиса идентификации и контроля доступа.

Примечание

IAM-токен действует не больше 12 часов и ограничен временем жизни cookie у федерации. После истечения срока жизни токена вернется ошибка с кодом 401 Unauthorized.

Предыдущая
API Яндекс Вики
Следующая
Примеры использования API