Довідка API MediaWiki

Яку дію виконати. Цей параметр слід надсилати як частину URL-адреси запиту (не в тілі POST) для зручності використання під час налагодження, аналітики та маршрутизації чи фільтрації запитів.

acquiretempusername

Отримує тимчасове імʼя користувача та зберігає його в поточній сесії, якщо увімкнено створення тимчасових облікових записів і поточний користувач вийшов із системи. Якщо імʼя вже збережено, повертає те саме ім'я.

block

Заблокувати користувача.

changeauthenticationdata

Зміна параметрів автентифікації для поточного користувача.

changecontentmodel

Змінити модель вмісту сторінки

checktoken

Перевірити коректність токена з action=query&meta=tokens.

clearhasmsg

Очищає прапорець hasmsg для поточного користувача.

clientlogin

Увійдіть у вікі з допомогою інтерактивного потоку.

compare

Отримати порівняння двох сторінок.

createaccount

Створити новий обліковий запис користувача.

delete

Вилучити сторінку.

edit

Створювати і редагувати сторінки.

emailuser

Надіслати електронного листа користувачеві

expandtemplates

Розгортає усі шаблони в межах вікірозмітки.

feedcontributions

Повертає стрічку внеску користувача.

feedrecentchanges

Видає стрічку нових редагувань.

feedwatchlist

Видає стрічку списку спостереження.

filerevert

Повернути файл до старої версії.

help

Відображати довідку для зазначених модулів.

imagerotate

Поворот одного або декількох зображень.

import

Імпортувати сторінку з іншої вікі або з XML-файлу.

languagesearch

Пошук назв мов у будь-якому написанні.

linkaccount

Пов'язати обліковий запис третьої сторони з поточним користувачем.

login

Увійти в систему й отримати куки автентифікації.

logout

Вийти й очистити дані сесії.

managetags

Виконати керівні завдання щодо зміни теґів.

mergehistory

Об'єднання історій редагувань.

move

Перейменувати сторінку.

opensearch

Шукати у вікі з використанням протоколу OpenSearch.

options

Змінити налаштування поточного користувача.

paraminfo

Отримати інформацію про модулі API.

parse

Аналізує вміст і видає парсер виходу.

patrol

Відпатрулювати сторінку чи версію.

protect

Змінити рівень захисту сторінки.

purge

Очистити кеш для вказаних заголовків.

query

Вибірка даних з і про MediaWiki.

removeauthenticationdata

Вилучити параметри автентифікації для поточного користувача.

resetpassword

Відправити користувачу лист для відновлення пароля.

revisiondelete

Вилучити або відновити версії.

rollback

Скасувати останнє редагування цієї сторінки.

rsd

Експортувати як схему RSD (Really Simple Discovery).

setnotificationtimestamp

Оновити часову мітку сповіщень для сторінок, що спостерігаються.

setpagelanguage

Змінити мову сторінки.

tag

Додати або вилучити зміни міток з окремих версій або записів журналу.

unblock

Розблокувати користувача.

undelete

Відновити версії вилученої сторінки.

unlinkaccount

Вилучити пов'язаний обліковий запис третьої сторони з поточного користувача.

upload

Завантажити файл, або отримати статус завантажень у процесі.

userrights

Змінити членство користувача у групах.

validatepassword

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

watch

Додати або вилучити сторінки з списку спостереження поточного користувача.

cspreport

Внутрішній. Використовується браузерами для повідомлення порушень Правил безпеки контенту (Content Security Policy). Цей модуль не повинен використовуватися, окрім випадків автоматичного використання веб-браузером для CSP-скарги.

stashedit

Внутрішній. Підготувати редагування в загальний кеш.

Формат виводу.

json

Вивести дані у форматі JSON.

jsonfm

Вивести дані у форматі JSON (вивід відформатованого коду за допомогою HTML).

none

Нічого не виводити.

php

Виводити дані у форматі серіалізованого PHP.

phpfm

Виводити дані у форматі серіалізованого PHP (вивід відформатованого коду за допомогою HTML).

rawfm

Виводити дані, включно з елементами налагодження, у форматі JSON (вивід відформатованого коду за допомогою HTML).

xml

Виводити дані у форматі XML.

xmlfm

Вивести дані у форматі XML (вивід відформатованого коду за допомогою HTML).

Максимальна затримка може використовуватися, коли MediaWiki інстальовано на реплікований кластер бази даних. Щоб зберегти дії, які спричиняють більшу затримку реплікації, цей параметр може змусити клієнт почекати, поки затримка реплікації не буде меншою за вказане значення. У випадку непомірної затримки, видається код помилки maxlag з повідомленням на зразок Очікування на $host: $lag секунд(и) затримки.
Див. Manual: Maxlag parameter для детальнішої інформації.

Встановити s-maxage HTTP кеш-контроль заголовок на стільки секунд. Помилки ніколи не кешуються.

Встановити max-age HTTP кеш-контроль заголовок на стільки секунд. Помилки ніколи не кешуються.

Перевірити, що користувач увійшов у систему (у тому числі, можливо, тимчасовий користувач), якщо задано user, не увійшов у систему, якщо задано anon, або має права бота, якщо задано bot.

Перевірити, чи поточний користувач є найменованим користувачем.

Будь-яке значення, вказане тут, буде включене у відповідь. Може використовуватися, щоб відрізняти запити.

Включити в результати ім'я хоста, який обробив запит.

Включити в результат поточну мітку часу.

Включати мови, які були використані для uselang і errorlang, у результат.

При доступі до API з використанням крос-доменного AJAX-запиту (CORS), задайте параметру значення вихідного домена. Він має бути включений у будь-який попередній запит і таким чином мусить бути частиною запиту URL (не тіла POST).

Для автентифікованих запитів він повинен точно збігатися з одним із виходів у заголовку Origin, тобто бути заданим чимось на зразок https://uk.wikipedia.org або https://meta.wikimedia.org. Якщо цей параметр не збігається із заголовком Origin, повернеться помилка 403. Якщо цей параметр збігається із заголовком Origin і вихід знаходиться у дозволеному списку, буде встановлено заголовки Access-Control-Allow-Origin і Access-Control-Allow-Credentials.

Для неавтентифікованих запитів укажіть значення *. Це дасть встановлення заголовка Access-Control-Allow-Origin, але Access-Control-Allow-Credentials буде false і всі дані про користувача будуть заборонені.

При доступі до API за допомогою міждоменного запиту AJAX (CORS) та використання провайдера сеансів, захищеного від атак міжсайтового підроблення запитів (CSRF) (наприклад, OAuth), використовуйте це замість origin=*, щоб зробити запит автентифікованим (тобто не вийти з системи). Це повинно бути включено в будь-який попередній запит, а тому повинно бути частиною URL запиту (а не тіла POST).

Зверніть увагу, що більшість постачальників сеансів, включаючи стандартні сеанси на основі файлів cookie, не підтримують автентифікований CORS і не можуть використовуватися з цим параметром.

Мова, що використовується для перекладу повідомлень. Список кодів видає action=query&meta=siteinfo&siprop=languages. Ви можете вказати user на використання поточного налаштування мови користувача, або вказати content на використання мови вмісту цієї вікі.

Варіант мови. Працює лише, якщо базова мова підтримує конвертацію між варіантами.

Формат, що використовується для виведення тексту попередження та помилки

plaintext

Вікітекст із вилученими тегами HTML та заміною сутностей.

wikitext

Нерозбірний вікітекст.

html

HTML

raw

Ключ повідомлення та параметри.

none

Немає тексту, лише коди помилок.

bc

Формат, що використовувався до MediaWiki 1.29. errorlang і errorsuselocal ігноруються.

Мова, яку використовувати для попереджень і помилок. action=query&meta=siteinfo&siprop=languages повертає список кодів мов. Вкажіть content, щоб використати мову вмісту поточної вікі, або uselang, щоб використовувати те ж значення, що й параметр uselang.

Якщо задано, тексти помилок використовуватимуть локальні повідомлення з простору назв MediaWiki.