Довідка API MediaWiki

Це автоматично генерована сторінка документації API MediaWiki.

Документація та приклади: 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, та з усіма полями, що були передані до повернутої URL-адреси, після чого повторіть крок 4.
- Якщо Ви отримали RESTART, це означає, що автентифікація спрацювала, але ми не маємо пов'язаного облікового запису користувача. Ви можете розцінити це як UI, або як FAIL.

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

Параметри:

loginrequests

Використовувати ці автентифікаційні запити через id, що повертається з action=query&meta=authmanagerinfo за допомогою amirequestsfor=login, або з попередньої відповіді з цього модуля.

Розділіть значення з допомогою | або альтернативу.

Максимальна кількість значень — 50 (500 для клієнтів дозволено вищі ліміти).

loginmessageformat

Формат до використання для повернення повідомлень.

Одне з наступних значень: html, none, raw, wikitext

Стандартно: wikitext

loginmergerequestfields

Об'єднати інформацію всіх автентифікаційних запитів у один масив.

Тип: логічний (подробиці)

loginpreservestate

Зберегти статус з попередньої спроби входу, що не вдалась, якщо можливо.

Тип: логічний (подробиці)

loginreturnurl

URL-адреса повернення для сторонніх автентифікаційних потоків повинна бути абсолютною. Обов'язковим є це, або logincontinue.

При отриманні відповіді REDIRECT, найбільш звичною Вашою дією буде відкриття браузерного чи іншого веб-перегляду вказаного URL-посилання для стороннього потоку автентифікації. Коли ця операція буде завершена, стороння програма перенаправить веб-переглядач на цю URL-адресу. Ви повинні видобувати будь-які параметри запитів або POST-параметри із цієї URL-адреси, і передавати їх як запит logincontinue до цього модуля API.

logincontinue

Цей запит є продовженням після попередньої відповіді UI або REDIRECT. Або це, або loginreturnurl є обов'язковим.

Тип: логічний (подробиці)

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 для двофакторної автентифікації, надаючи OATHToken як 987654.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [відкрити в пісочниці]