Справка MediaWiki API

Это автоматически сгенерированная страница документации MediaWiki API.

Документация и примеры: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

( main | clientlogin )

Этот модуль требует прав на запись.
Этот модуль принимает только POST-запросы.
Источник: MediaWiki
Лицензия: GPL-2.0-or-later

Вход в вики с помощью интерактивного потока.

Стандартная процедура использования этого модуля такова:

Запрос полей, доступных из action=query&meta=authmanagerinfo с amirequestsfor=login, и токена login из action=query&meta=tokens.
Предоставление полей пользователю и получение его данных.
Запрос к этому модулю, содержащий loginreturnurl или аналогичное поле.
Проверка поля status ответа.
- Если вы получили PASS или FAIL, вы закончили. Операция либо завершилась успехом, либо нет.
- Если вы получили UI, предоставьте новые поля пользователю и получите новые данные. Затем совершите новый запрос с параметром logincontinue и новыми полями, после чего повторите пункт 4.
- Если вы получили REDIRECT, отправьте пользователя на redirecttarget и подождите возвращения на loginreturnurl. Затем совершите запрос к этому модулю с параметром logincontinue и всеми полями, содержащимися в возвращённой ссылке, и повторите пункт 4.
- Если вы получили RESTART, это означает, что аутентификация работает, но мы не привязали пользовательский аккаунт. Вы можете рассматривать это как UI или FAIL.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login

Определённые параметры:

Other general parameters are available.

loginrequests

Использовать только эти аутентификационные запросы, с id, возвращённом из action=query&meta=authmanagerinfo с amirequestsfor=login, или из предыдущего ответа этого модуля.

Разделяйте значения с помощью | или альтернативного разделителя .

Максимальное количество значений ? 50 (500 для клиентов, которым разрешены более высокие лимиты).

loginmessageformat

Формат, используемый для возвращаемых сообщений.

Одно из следующих значений: html, none, raw, wikitext

По умолчанию: wikitext

loginmergerequestfields

Слить поля информации со всех аутентификационных запросов в один массив.

Type: boolean ( details )

loginpreservestate

Сохранить состояние с предыдущей провалившейся попытки авторизации, если возможно.

Type: boolean ( details )

loginreturnurl

Вернуть ссылку для стороннего процесса аутентификации, должна быть абсолютной. Либо этот параметр, либо logincontinue, обязателен.

После получения ответа REDIRECT, вы, как правило, должны открыть в браузере или вэб-просмотрщике указанную в redirecttarget ссылку для продолжения стороннего процесса аутентификации. По завершению, сторонний сервис отошлёт браузеру или веб-просмотрщику эту ссылку. Вы должны извлечь все параметры из ссылки и отослать их в параметр logincontinue запроса к этому модулю.

logincontinue

Этот запрос ? продолжение после предшествующего ответа UI или REDIRECT. Либо этот параметр, либо loginreturnurl, обязателен.

Type: boolean ( details )

logintoken

Токен ≪login≫, полученный из action=query&meta=tokens

Это обязательный параметр.

*

Этот модуль принимает дополнительные параметры в зависимости от доступных аутентификационных запросов. Используйте action=query&meta=authmanagerinfo с amirequestsfor=login (или предыдущий ответ этого модуля, если доступен) для определения, какие запросы доступны и какие поля они используют.

Примеры:

Начать вход в вики в качестве участника Example с паролем ExamplePassword.: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [открыть в песочнице]
Продолжить вход после ответа UI для двухфакторной аутентификации, предоставив 987654 в качестве токена OATHToken.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [открыть в песочнице]