Справка MediaWiki API
Это автоматически сгенерированная страница документации MediaWiki API.
Документация и примеры: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Главный модуль
- Источник: MediaWiki
- Лицензия: GPL-2.0-or-later
- //lists.wikimedia.org/postorius/lists/mediawiki-api.lists.wikimedia.org/Почта таратыу]
- [https
- //lists.wikimedia.org/postorius/lists/mediawiki-api-announce.lists.wikimedia.org/ API яңылыҡтары]
- [https
- //phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R Хаталар һәм һорауҙар]
Статус: Был биттә күрһәтелгән бар функциялар ҙа эшләргә тейеш, шулай ҙа API әүҙем эшкәртеү хәлендә тора һәм теләгән бер ваҡытта үҙгәрергә мөмкин. Яңыртылыуҙарҙы һәр саҡ белеп торор өсөн почта таратыу mediawiki-api-announce, ошоға яҙыл.
Хаталы һоратыуҙар: Әгәр API хаталы һоратыу алһа, HTTP баш һүҙе «MediaWiki-API-Error» асҡысы менән кире ҡайтарыла, бынан һуң баш һүҙҙең мәғәнәһе һәм хата коды кире ебәреләсәк һәм кире шул уҡ мәғәнәлә кире ҡуйыласаҡ. Киңерәк мәғлүмәтте ошонан ҡара API: Хаталар һәм иҫкәртеүҙәр.
Тестлау: API-һоратыуҙарҙы тестлау уңайлы булһын өсөн ҡара. Special:ApiSandbox
- action
Үтәлергә тейешле ғәмәлдәр.
- abusefiltercheckmatch
- Проверьте, удовлетворяет ли фильтру злоупотреблений набор переменных или событие фильтра злоупотреблений, записанное редактором.
- abusefilterchecksyntax
- Проверка синтаксиса фильтра злоупотреблений.
- abusefilterevalexpression
- Вычисление выражения фильтра злоупотреблений
- abusefilterunblockautopromote
- Разблокировка получаемого автоповышения участника вследствие фильтра злоупотреблений.
- abuselogprivatedetails
- Просмотреть приватные данные записи журнала злоупотреблений.
- acquiretempusername
- Получить временное имя пользователя и сохраните его в текущем сеансе, если создание временной учетной записи включено и текущий пользователь вышел из системы. Если имя уже сохранено, возвращается то же имя.
- antispoof
- Проверка имени с помощью AntiSpoof.
- block
- Ҡатнашыусыны бикләү.
- centralauthtoken
- Получить токен CentralAuth для аутентифицированного запроса к связанной вики
- centralnoticecdncacheupdatebanner
- Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
- centralnoticechoicedata
- Get data needed to choose a banner for a given project and language
- centralnoticequerycampaign
- Get all configuration settings for a campaign.
- changeauthenticationdata
- Смена параметров аутентификации для текущего участника.
- changecontentmodel
- Изменить модель содержимого страницы
- checktoken
- action=query&meta=tokens токенының дөрөҫлөгөн тикшерегеҙ.
- cirrus-config-dump
- Дамп конфигурации CirrusSearch.
- cirrus-mapping-dump
- Дамп маппинга CirrusSearch для этой вики.
- cirrus-profiles-dump
- Dump of CirrusSearch profiles for this wiki.
- cirrus-settings-dump
- Дамп настроек CirrusSearch для этой вики.
- clearhasmsg
- Ағымдағы ҡатнашыусының
hasmsg
флагын таҙарта. - clientlogin
- Вход в вики с помощью интерактивного потока.
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- Ике бит араһындағы айырма алыу.
- createaccount
- Ҡатнашыусыларҙың яңы иҫәп яҙмаларын булдырыу.
- createlocalaccount
- Forcibly create a local account. The central account must exist.
- cxdelete
- Удалить черновой перевод, созданный с помощью расширения «Инструмент перевода».
- cxsuggestionlist
- Управление списками предположений. Добавление предположений в списки и их удаление.
- cxtoken
- Получить токены JWT для аутентификации с помощью cxserver.
- delete
- Битте юйырға.
- deleteglobalaccount
- Удалить глобального участника.
- discussiontoolsedit
- Отправить сообщение на страницу обсуждения.
- discussiontoolsfindcomment
- Найти комментарий по его идентификатору или названию.
- discussiontoolsgetsubscriptions
- Получить состояния подписки на заданные темы.
- discussiontoolssubscribe
- Подписаться (или отменить подписку), чтобы получать уведомления по теме.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Manually trigger a notification to a user
- echomarkread
- Отметить уведомления как прочитанные для текущего пользователя.
- echomarkseen
- Отметить уведомления как прочитанные для данного пользователя.
- echomute
- Игнорировать или убрать из игнорируемых уведомления от определённых участников или страниц.
- edit
- Биттәрҙе төҙөргә һәм мөхәррирләргә.
- editmassmessagelist
- Edit a mass message delivery list.
- emailuser
- Ҡатнашыусыға хат.
- expandtemplates
- wikitext ҡалыптарын аса.
- featuredfeed
- Возвращает ленту избранных материалов.
- feedcontributions
- Ҡатнашыусылар өлөшө менән теҙмәне ҡайтара.
- feedrecentchanges
- Һуңғы үҙгәрештәр теҙмәһен ҡайтара.
- feedwatchlist
- Күҙәтеү каналын ҡайтара.
- filerevert
- Файлды иҫке өлгөһөнә ҡайтарырға.
- globalblock
- Глобально заблокировать или разблокировать участника.
- globalpreferenceoverrides
- Изменить локальную замену для глобальных настроек текущего участника.
- globalpreferences
- Сменить глобальные настройки текущего участника.
- globaluserrights
- Добавлять участников в глобальную группу (или удалять из неё).
- growthmanagementorlist
- Manage information in the structured mentor list (usually stored in MediaWiki:GrowthMentors.json). This module can be used by both current and future mentors (to add themselves or change their details) and administrators (for all users).
- growthmentordashboardupdatedata
- Запланировать внеочередное обновление модуля обзора подопечных на панели наставника. По рабочим соображениям вы можете запланировать не более одного обновления в течение двух часов.
- growthsetmenteestatus
- Установить статус подопечного (позволяет подопечным включать/отключать модуль наставничества или полностью отказываться от участия, что удаляет отношения подопечный/наставник)
- growthsetmentor
- Установить наставника участнику. Изменения будут зафиксированы публично.
- growthstarmentee
- Отметить или снять пометку с подопечного как помеченного этим пользователем (хранится закрыто и не логируется)
- help
- Күрһәтелгән модулдәр белешмәһен күрһәтергә.
- homepagequestionstore
- Получить отформатированные вопросы, размещенные через модули домашней страницы.
- imagerotate
- Был модуль һүндерелгән.
- import
- Импорт страницы из другой вики или XML-файла.
- jsonconfig
- Обеспечивает прямой доступ к подсистеме JsonConfig.
- languagesearch
- Поиск названий языков на любом алфавите.
- linkaccount
- Связать учётную запись третьей стороны с текущим участником.
- login
- Вход и получение аутентификационных файлов cookie.
- logout
- Сығырға һәм сессия мәғлүмәтен юйырға.
- managetags
- Тамғаларҙы үҙгәртеүгә бәйле мәсьәләләрҙе тормошҡа ашырыу.
- massmessage
- Отправить сообщение по списку страниц.
- mergehistory
- Үҙгәртеүҙәр тарихын берләштереү.
- move
- Биттең исемен үҙгәртергә.
- opensearch
- OpenSearch протоколын ҡулланып, вики буйынса эҙләү.
- options
- Смена настроек текущего участника.
- paraminfo
- API модуле тураһында мәғлүмәт алырға.
- parse
- Парсит содержимое и возвращает результат парсинга.
- patrol
- Патрулирование страницы или версии.
- protect
- Битте һаҡлау кимәлен үҙгәртергә.
- purge
- Очистка кэша заданных страниц.
- query
- Запросить данные с и о MediaWiki.
- removeauthenticationdata
- Удаление аутентификационных данных для текущего участника.
- resetpassword
- Отправить участнику письмо для сброса пароля.
- revisiondelete
- Удаление и восстановление версий страниц.
- rollback
- Отмена последней правки на странице.
- rsd
- Экспорт схемы RSD (Really Simple Discovery).
- setglobalaccountstatus
- Установить глобальный статус пользователя.
- setnotificationtimestamp
- Обновление временной метки уведомления для отслеживаемых страниц.
- setpagelanguage
- Изменить язык страницы.
- shortenurl
- Сократить длинный URL-адрес в более короткий.
- sitematrix
- Получить список Викимедиа.
- spamblacklist
- Проверить один или несколько URL-адресов на наличие в списке запрещённых ссылок.
- streamconfigs
- Exposes event stream config. Returns only format=json with formatversion=2.
- strikevote
- Позволяет администраторам вычеркивать голоса или снимать с них вычёркивание.
- sxdelete
- Delete the draft section translation and its parallel corpora from database.
- tag
- Добавление или удаление меток отдельных правок или записей журналов.
- templatedata
- Получить данные, сохранённые расширением TemplateData.
- thank
- Отправка редактору уведомления о благодарности.
- titleblacklist
- Подтвердите заголовок страницы, имя файла или имя пользователя в списке TitleBlacklist.
- torblock
- Check if an IP address is blocked as a Tor exit node.
- transcodereset
- Users with the 'transcode-reset' right can reset and re-run a transcode job.
- unblock
- Разблокировка участника.
- undelete
- Восстановление версий удалённой страницы.
- unlinkaccount
- Удаление связанного стороннего аккаунта с текущим участником.
- upload
- Загрузка файла или получение статуса незавершённых загрузок.
- userrights
- Изменение групп участника.
- validatepassword
- Проверка пароля на удовлетворение политики вики.
- watch
- Добавление или удаление страниц из списка наблюдения текущего участника.
- webapp-manifest
- Возвращает манифест веб-приложения.
- webauthn
- API Module to communicate between server and client during registration/authentication process.
- bouncehandler
- Внутренний. Получите сообщение об отказе и обработайте его для обработки отказавшего получателя.
- categorytree
- Внутренний. Внутренний модуль для расширения CategoryTree.
- cirrus-check-sanity
- Внутренний. Reports on the correctness of a range of page ids in the search index
- collection
- Внутренний. API module for performing various operations on a wiki user's collection.
- cspreport
- Внутренний. Используется браузерами, чтобы сообщать о нарушениях политики безопасности (CSP). Этот модуль никогда не должен использоваться, за исключением случаев автоматического использования совместимыми с CSP браузерами.
- cxcheckunreviewed
- Внутренний. Check if any fast, unreviewed translation has been published recently for the current user.
- cxpublish
- Внутренний. Сохранить страницу, созданную с помощью расширения «Перевод содержимого».
- cxpublishsection
- Внутренний. Save a section created using the Content Translation extension's section translation feature.
- cxsave
- Внутренний. Этот модуль позволяет сохранять черновые переводы по разделам для экономии трафика и создания подборки текстов, переведённых на разные языки.
- cxsplit
- Внутренний. Create and save a section translation to database, for every translated section of the given article translation
- discussiontoolscompare
- Внутренний. Получить информацию об изменениях комментариев между двумя версиями страницы.
- discussiontoolspageinfo
- Внутренний. Возвращает метаданные, необходимые для инициализации Discussion tools.
- discussiontoolspreview
- Внутренний. Предварительный просмотр сообщения на странице обсуждения.
- echopushsubscriptions
- Внутренний. Управление push-подписками для текущего участника.
- editcheckreferenceurl
- Внутренний. Check the status of a URL for use as a reference.
- fancycaptchareload
- Внутренний. Получение новой FancyCaptcha.
- growthinvalidateimagerecommendation
- Внутренний. Недействительная рекомендация изображения.
- growthinvalidatepersonalizedpraisesuggestion
- Внутренний. Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
- helppanelquestionposter
- Внутренний. Работа с вопросами, заданными через текущего участника.
- jsondata
- Внутренний. Вызывает локализованные JSON-данные.
- oathvalidate
- Внутренний. Подтвердите двухфакторный токен аутентификации (OATH).
- parser-migration
- Внутренний. Parse a page with two different parser configurations.
- readinglists
- Внутренний. Reading list write operations.
- sanitize-mapdata
- Внутренний. Выполняет проверку данных для расширения Kartographer
- scribunto-console
- Внутренний. Internal module for servicing XHR requests from the Scribunto console.
- securepollauth
- Внутренний. Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- Внутренний. Подготовка правки в общем кэше.
- sxsave
- Внутренний. Save the draft section translation and store the parallel corpora
- timedtext
- Внутренний. Provides timed text content for usage by <track> elements
- ulslocalization
- Внутренний. Получить локализацию ULS на указанном языке.
- ulssetlang
- Внутренний. Update user's preferred interface language.
- visualeditor
- Внутренний. Возвращает HTML5 для страницы с сервиса Parsoid.
- visualeditoredit
- Внутренний. Сохранить в MediaWiki страницу в формате HTML5 (сконвертированную в вики-текст с помощью Parsoid).
- wikimediaeventsblockededit
- Внутренний. Log information about blocked edit attempts
- Одно из следующих значений: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, communityconfigurationedit, compare, createaccount, createlocalaccount, cxdelete, cxsuggestionlist, cxtoken, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, growthmanagementorlist, growthmentordashboardupdatedata, growthsetmenteestatus, growthsetmentor, growthstarmentee, help, homepagequestionstore, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, sxdelete, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, cxcheckunreviewed, cxpublish, cxpublishsection, cxsave, cxsplit, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, echopushsubscriptions, editcheckreferenceurl, fancycaptchareload, growthinvalidateimagerecommendation, growthinvalidatepersonalizedpraisesuggestion, helppanelquestionposter, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, sxsave, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
- По умолчанию: 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» с сообщением «Waiting for $host: $lag seconds lagged».
См. подробнее на странице с описанием Manual: параметра Maxlag.- Тип: целочисленное значение
- smaxage
HTTP-атаманың мәғәнәһен
s-maxage
бирелгән секунд эсендә билдәләргә. Хаталар бер ваҡытта ла кэшланмай.- Тип: целочисленное значение
- Значение должно быть не меньше 0.
- По умолчанию: 0
- maxage
HTTP-атаманың мәғәнәһен
s-maxage
бирелгән секунд эсендә билдәләргә. Хаталар бер ваҡытта ла кэшланмай.- Тип: целочисленное значение
- Значение должно быть не меньше 0.
- По умолчанию: 0
- assert
Әгәр user бирелһә - танылған ҡатнашыусы, not булһа anon - аноним, bot икән робот хоҡуҡтарына эйә икәненә инанығыҙ.
- Одно из следующих значений: anon, bot, user
- assertuser
Проверить, что ник текущего участника совпадает с заданным.
- Төр: ҡатнашыусы, теләһә ниндәй ҡатнашыусы исеме һәм Ваҡытлыса ҡатнашыусы
- requestid
Бында бирелгән һәр мәғәнә яуапҡа индереләсәк. Һорауҙарҙы айырыу өсөн файҙаланылырға мөмкин
- servedby
Һөҙөмтәләргә һоратыуҙы эшкәрткән хост исемен индерергә.
- Тип: булева (подробнее)
- curtimestamp
Һөҙөмтәләргә ағымдағы ваҡыт тамғаһы ҡуйырға.
- Тип: булева (подробнее)
- responselanginfo
Включить языки, использованные для uselang и errorlang, в результат.
- Тип: булева (подробнее)
- origin
API мөрәжәғәт иткәндә AJAX-һорау (CORS) кросс-домены ҡулланһағыҙ, параметрға тәүге домен мәғәнәһен бирегеҙ. Ул алдағы һорауҙа булырға һәм шул рәүешле URI-һорауҙың (POST түгел) бер өлөшө булырға тейеш. Ул атамалағы бер сығанаҡҡа
Origin
тап килергә тейеш, мәҫәлән, https://ru.wikipedia.org йәки https://meta.wikimedia.org. Әгәр ҙә параметр атамаға
Origin
тура килмәһә, яуап 403 хата коды менән кире ҡайтарыла. Әгәр параметр
Origin
атамаға тура килһә, һәм сығанаҡ рөхсәт ителгән исемлектә икән,Access-Control-Allow-Origin
тигән атама ҡуйыласаҡ.- uselang
Язык, используемый для перевода сообщений. Запрос action=query&meta=siteinfo&siprop=languages возвращает список кодов языков. Вы можете указать user, чтобы использовать текущие языковые настройки участника, или content для использования основного языка этой вики.
- По умолчанию: user
- variant
Вариант языка. Работает только в том случае, если базовый язык поддерживает преобразование вариантов.
- errorformat
Формат, используемый для вывода текста предупреждений и ошибок
- plaintext
- Вики-текст с удалёнными 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.
- Тип: булева (подробнее)
- centralauthtoken
При обращении к API посредством кроссдоменного AJAX-запроса (CORS) используйте это для авторизации в качестве текущего SUL-пользователя. Используйте action=centralauthtoken на этой вики для запроса токена, прежде чем делать CORS-запрос. Каждый токен может быть использован только раз и действителен только 10 секунд. Он должен быть включён в каждый предварительный запрос и — ввиду этого — в запрашиваемый URI (не в тело POST).
- Төп модулгә ярҙам.
- api.php?action=help [открыть в песочнице]
- Бар белешмә бер биттә.
- api.php?action=help&recursivesubmodules=1 [открыть в песочнице]
Типы данных
Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.
Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.
Some parameter types in API requests need further explanation:
- boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
- expiry
Expiry values may be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.
- timestamp
Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.
Шаблонные параметры
Шаблонные параметры используются в случаях, когда модулю API нужно получить по параметру со значением на каждое значение другого параметра. Например, если бы был модуль API, запрашивающий фрукты, у него мог бы быть параметр фрукты, указывающий, какие фрукты запрашиваются, и шаблонный параметр {фрукт}-в-количестве, указывающий, сколько фруктов каждого вида запросить. Клиент API, который хочет запросить 1 яблоко, 5 бананов и 20 апельсинов, мог бы тогда сделать запрос наподобие фрукты=яблоки|бананы|апельсины&яблоки-в-количестве=1&бананы-в-количестве=5&апельсины-в-количестве=20.
Создатели
Разработчики API:
- Yuri Astrakhan (создатель, ведущий разработчик с сентября 2006 по сентябрь 2007)
- Roan Kattouw (ведущий разработчик 2007—2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (ведущий разработчик 2013—2020)
Пожалуйста, присылайте ваши комментарии, предложения и вопросы на адрес [email protected] или присылайте отчёты об ошибках на https://phabricator.wikimedia.org/.