Довідка API MediaWiki

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

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

Головний модуль

Джерело: MediaWiki
Ліцензія: GPL-2.0-or-later

Статус: Усі функції, вказані на цій сторінці, мають працювати, але API далі перебуває в активній розробці і може змінитися у будь-який момент. Підпишіться на список розсилки mediawiki-api-announce, щоб помічати оновлення.

Хибні запити: Коли до API надсилаються хибні запити, буде відіслано HTTP-шапку з ключем «MediaWiki-API-Error», а тоді і значення шапки, і код помилки, надіслані назад, будуть встановлені з тим же значенням. Більше інформації див. на сторінці API: Помилки й попередження.

Тестування: Для зручності тестування запитів API, див. Special:ApiSandbox.

Параметри:

action

Яку дію виконати.

abusefiltercheckmatch: Перевірити, щоб побачити, чи відповідає фільтр зловживань набору змінних, редагуванню чи журнальовані дії фільтра зловживань.
abusefilterchecksyntax: Перевірити синтаксис фільтра зловживань.
abusefilterevalexpression: Оцінює вираз фільтра зловживань.
abusefilterunblockautopromote: Розблоковує користувача від отримування автоматичних просувань через послідовність фільтрів.
abuselogprivatedetails: Переглянути приватні деталі запису в журналі фільтра зловживань.
antispoof: Перевірите ім'я користувача через перевірку нормалізації AntiSpoof.
block: Заблокувати користувача.
changeauthenticationdata: Зміна параметрів автентифікації для поточного користувача.
changecontentmodel: Змінити модель вмісту сторінки
checktoken: Перевірити коректність токена з action=query&meta=tokens.
clearhasmsg: Очищає прапорець hasmsg для поточного користувача.
clientlogin: Увійдіть у вікі з допомогою інтерактивного потоку.
compare: Отримати порівняння двох сторінок.
createaccount: Цей модуль було відключено.
delete: Вилучити сторінку.
echomarkread: Позначити сповіщення як прочитані для поточного користувача.
echomarkseen: Позначити сповіщення як переглянуті для поточного користувача.
echomute: Приглушити або повернути сповіщення від деяких сторінок чи користувачів.
edit: Створювати і редагувати сторінки.
emailuser: Надіслати електронного листа користувачеві
expandtemplates: Розгортає усі шаблони в межах вікірозмітки.
feedcontributions: Повертає стрічку внеску користувача.
feedrecentchanges: Видає стрічку нових редагувань.
feedwatchlist: Видає стрічку списку спостереження.
filerevert: Повернути файл до старої версії.
help: Відображати довідку для зазначених модулів.
imagerotate: Поворот одного або декількох зображень.
import: Імпортувати сторінку з іншої вікі або з XML-файлу.
linkaccount: Пов'язати обліковий запис третьої сторони з поточним користувачем.
login: Увійти в систему й отримати куки автентифікації.
logout: Вийти й очистити дані сесії.
managetags: Виконати керівні завдання щодо зміни теґів.
mergehistory: Об'єднання історій редагувань.
move: Перейменувати сторінку.
opensearch: Шукати у вікі з використанням протоколу OpenSearch.
options: Змінити налаштування поточного користувача.
paraminfo: Отримати інформацію про модулі API.
parse: Аналізує вміст і видає парсер виходу.
patrol: Відпатрулювати сторінку чи версію.
pollsubmitvote: API-модуль AJAXPoll
problemreportsgetform: Fetch the HTML of the "report a problem" dialog.
problemreportupdate: Update or delete a problem report.
protect: Змінити рівень захисту сторінки.
purge: Очистити кеш для вказаних заголовків.
query: Вибірка даних з і про MediaWiki.
regexblock: Блокувати імена користувачів та IP-адреси за допомогою регулярних виразів.
regexunblock: Розблокувати імена користувачів та IP-адреси за допомогою регулярних виразів.
removeauthenticationdata: Вилучити параметри автентифікації для поточного користувача.
reportproblem: Report a problem with a wiki page.
resetpassword: Відправити користувачу лист для відновлення пароля.
revisiondelete: Вилучити або відновити версії.
rollback: Скасувати останнє редагування цієї сторінки.
rsd: Експортувати як схему RSD (Really Simple Discovery).
setnotificationtimestamp: Оновити часову мітку сповіщень для сторінок, що спостерігаються.
setpagelanguage: Змінити мову сторінки.
spamblacklist: Перевірити одну або кілька URL-адрес на наявність у SpamBlacklist.
spamregex: Додайте записи у «Регулярні вирази спаму» або видаліть вже заблоковані.
tag: Додати або вилучити зміни міток з окремих версій або записів журналу.
templatedata: Отримати дані, що зберігаються розширенням TemplateData.
thank: Надіслати редактору сповіщення про подяку.
themelist: Отримати список усіх оформлень і їхніх тем
titleblacklist: Перевірити назву сторінки, файлу або ім'я користувача на наявність у чорному списку назв.
unblock: Розблокувати користувача.
undelete: Відновити версії вилученої сторінки.
unlinkaccount: Вилучити пов'язаний обліковий запис третьої сторони з поточного користувача.
upload: Завантажити файл, або отримати статус завантажень у процесі.
userrights: Змінити членство користувача у групах.
validatepassword: Перевірити пароль на предмет відповідності політикам вікі щодо паролів.
watch: Додати або вилучити сторінки з списку спостереження поточного користувача.
webapp-manifest: Виводить маніфест webapp.
mobileview: Застарілий. Виводить дані, необхідні для мобільних переглядів.
tokens: Застарілий. Отримати жетони для дій пов'язаних зі зміною даних.
categorytree: Внутрішній. Внутрішній модуль для розширення CategoryTree.
cspreport: Внутрішній. Використовується браузерами для повідомлення порушень Правил безпеки контенту (Content Security Policy). Цей модуль не повинен використовуватися, окрім випадків автоматичного використання веб-браузером для CSP-скарги.
scribunto-console: Внутрішній. Внутрішній модуль обробки XHR-запитів з консолі Scribunto.
stashedit: Внутрішній. Підготувати редагування в загальний кеш.
visualeditor: Внутрішній. Повертає HTML5 для сторінки від сервісу Parsoid.
visualeditoredit: Внутрішній. Зберегти HTML5-сторінку у MediaWiki (конвертовану у вікітекст сервісом Parsoid).

Одне з наступних значень: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, antispoof, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, echomarkread, echomarkseen, echomute, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, pollsubmitvote, problemreportsgetform, problemreportupdate, protect, purge, query, regexblock, regexunblock, removeauthenticationdata, reportproblem, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, spamregex, tag, templatedata, thank, themelist, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, mobileview, tokens, categorytree, cspreport, scribunto-console, stashedit, visualeditor, visualeditoredit

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

format

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

json: Вивести дані у форматі JSON.
jsonfm: Вивести дані у форматі JSON (вивід відформатованого коду за допомогою HTML).
none: Нічого не виводити.
php: Виводити дані у форматі серіалізованого PHP.
phpfm: Виводити дані у форматі серіалізованого PHP (вивід відформатованого коду за допомогою HTML).
rawfm: Виводити дані, включно з елементами налагодження, у форматі JSON (вивід відформатованого коду за допомогою HTML).
xml: Виводити дані у форматі XML.
xmlfm: Вивести дані у форматі XML (вивід відформатованого коду за допомогою HTML).

Одне з наступних значень: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm

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

maxlag

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

Тип: ціле число

smaxage

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

Тип: ціле число

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

maxage

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

Тип: ціле число

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

assert

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

Одне з наступних значень: anon, bot, user

assertuser

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

Тип: користувач, подано як ім'я користувача

requestid

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

servedby

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

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

curtimestamp

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

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

responselanginfo

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

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

origin

При доступі до API з використанням крос-доменного AJAX-запиту (CORS), задайте параметру значення вихідного домена. Він має бути включений у будь-який попередній запит і таким чином мусить бути частиною запиту URI (не тіла 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 і всі дані про користувача будуть заборонені.

uselang

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

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

errorformat

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

plaintext: вікітекст із прираними HTML-тегами і заміненими HTML-мнемоніками.
wikitext: неопрацьований вікітекст.
html: HTML.
raw: лише ключ і параметри повідомлення.
none: без тексту, тільки коди помилок.
bc: формат, який використовувався до MediaWiki 1.29. errorlang і errorsuselocal ігноруються.

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

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

errorlang

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

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

errorsuselocal

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

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

Приклади:

Довідка для головного модуля.: api.php?action=help [відкрити в пісочниці]
Уся довідка на одній сторінці.: api.php?action=help&recursivesubmodules=1 [відкрити в пісочниці]

Дозволи:

writeapi: Використання API для запису; Надані: all, user, bot та globalbot
apihighlimits: Використовувати вищі ліміти у запитах API (повільні запити: 500; швидкі запити: 5000). Ліміти для повільних запитів також застосовуються до багатозначних параметрів.; Надані: bot, sysop, staff, globalbot та intern

Типи даних

Введені дані в MediaWiki мають бути в NFC-нормалізованому форматі UTF-8. MediaWiki може зробити спробу конвертувати дані в будь-якому іншому форматі, але це може спричинити невдачу деяких операцій (таких як редагування з перевірками MD5).

Параметри, які допускають два і більше значень, зазвичай подаються з цими значеннями, розділеними через вертикальну риску, напр., param=значення1|значення2 або param=значення1%7Cзначення2. Якщо ж значення повинно містити вертикальну риску, використовуйте U+001F (Unit Separator) як роздільник та додавайте до значення префікс U+001F, напр., param=%1Fзначення1%1Fзначення2.

Деякі типи параметрів у запитах до API потребують додаткових пояснень:

boolean: Логічні типи даних працюють як чекбокси з галочками в HTML: якщо параметр вказано, незалежно від значення, то він розцінюється як «true». Для значення «false», уникніть параметра цілковито.
expiry: Час може бути відносним (напр.,5 months чи 2 weeks) або абсолютним (напр., 2014-09-18T12:34:56Z). Щоб спостерігати за сторінкою безстроково, використовуйте infinite, indefinite, infinity, чи never.
timestamp: Мітки часу можна вказувати в різних форматах, див. формати вводу з бібліотеки міток часу, задокументовані на mediawiki.org, щоб дізнатись більше. Рекомендовано використовувати дату й час у форматі ISO 8601: 2001-01-15T14:56:00Z. Додатково можна використати рядок now для вказання поточної мітки часу.

Шаблонні параметри

Шаблонні параметри підтримують випадки, в яких модулю API необхідне значення для кожного значення якогось іншого параметра. Наприклад, якби був модуль API для запитів фруктів, у нього був би параметр fruits для зазначення, запит на які саме фрукти надсилається і шаблонний параметр {fruit}-quantity для зазначення, скільки саме кожного різновиду фруктів потрібно. Клієнт API, якому потрібні 1 яблуко, 5 бананів і 20 полуниць, таким чином, міг би надіслати запит у формі fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Автор(и)

Розробники API:

Roan Kattouw (головний розробник вер. 2007–2009)
Victor Vasiliev
Bryan Tong Minh
Sam Reed
Yuri Astrakhan (творець, головний розробник вер. 2006 – вер. 2007)
Brad Jorsch (головний розробник 2013 – тепер)

Будь ласка, надсилайте свої коментарі, пропозиції та запитання на mediawiki-api@lists.wikimedia.org або подайте звіт про помилку за адресою https://phabricator.wikimedia.org/.

Отримано з https://uk.shoutwiki.com/wiki/Спеціальна:ApiHelp