Шаблон:Api help/ru

{{#switch: | =

| #default=

{{#switch: | =

Главный модуль

Источник: MediaWiki
Лицензия: GPL-2.0-or-later

Статус: MediaWiki API — зрелый и стабильный интерфейс, активно поддерживаемый и улучшаемый. Мы стараемся избегать ломающих изменений, однако изредка они могут быть необходимы. Подпишитесь на почтовую рассылку mediawiki-api-announce, чтобы быть в курсе обновлений.

Ошибочные запросы: Если API получает запрос с ошибкой, вернётся заголовок HTTP с ключом «MediaWiki-API-Error», после чего значение заголовка и код ошибки будут отправлены обратно и установлены в то же значение. Более подробную информацию см. API: Ошибки и предупреждения.

Тестирование: для удобства тестирования API-запросов, см. Special:ApiSandbox.

Параметры:

action

Действие, которое следует выполнить.

block: Блокировка участника.
changeauthenticationdata: Смена параметров аутентификации для текущего участника.
checktoken: Проверить корректность токена из action=query&meta=token.
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: Вход в вики с помощью интерактивного потока.
compare: Получение разницы между двумя страницами.
createaccount: Создание новой учётной записи.
cspreport: Используется браузерами, чтобы сообщать о нарушениях политики безопасности (CSP). Этот модуль никогда не должен использоваться, за исключением случаев автоматического использования совместимыми с CSP браузерами.
delete: Удаление страницы.
edit: Создание и редактирование страниц.
emailuser: Написание электронных писем участнику.
embedvideo: Get generated video embed code for given parameters.
expandtemplates: Разворачивание всех шаблонов в вики-текст.
feedcontributions: Возвращает ленту с вкладом участников.
feedrecentchanges: Возвращает ленту последних изменений.
feedwatchlist: Возвращает ленту списка наблюдения.
filerevert: Возвращение файла к старой версии.
help: Отображение справки указанных модулей.
imagerotate: Поворот одного или нескольких изображений.
import: Импорт страницы из другой вики или XML-файла.
jsonconfig: Обеспечивает прямой доступ к подсистеме JsonConfig.
jsondata: Вызывает локализованные JSON-данные.
linkaccount: Связать аккаунт третьей стороны с текущим участником.
login: Вход и получение аутентификационных cookie.
logout: Выйти и очистить данные сессии.
managetags: Осуществление задач, связанных с изменением меток.
mergehistory: Объединение историй правок.
move: Переименование страницы.
opensearch: Поиск по вики с использованием протокола OpenSearch.
options: Смена настроек текущего участника.
paraminfo: Получение информации о модулях API.
parse: Парсит содержимое и возвращает результат парсинга.
patrol: Патрулирование страницы или версии.
protect: Изменение уровня защиты страницы.
purge: Очистка кэша заданных страниц.
query: Запросить данные с и о MediaWiki.
removeauthenticationdata: Удаление аутентификационных данных для текущего участника.
resetpassword: Отправить участнику письмо для сброса пароля.
revisiondelete: Удаление и восстановление версий страниц.
rollback: Отмена последней правки на странице.
rsd: Экспорт схемы RSD (Really Simple Discovery).
scribunto-console: Internal module for servicing XHR requests from the Scribunto console.
setnotificationtimestamp: Обновление временной метки уведомления для отслеживаемых страниц.
setpagelanguage: Изменить язык страницы.
stashedit: Подготовка правки в общем кэше.
tag: Добавление или удаление меток отдельных правок или записей журналов.
unblock: Разблокировка участника.
undelete: Восстановление версий удалённой страницы.
unlinkaccount: Удаление связанного стороннего аккаунта с текущим участником.
upload: Загрузка файла или получение статуса незавершённых загрузок.
userrights: Изменение групп участника.
validatepassword: Проверка пароля на удовлетворение политики вики.
watch: Добавление или удаление страниц из списка наблюдения текущего участника.
tokens: Устарело. Получение токенов для действий, связанных с редактированием данных.

Одно из следующих значений: block, changeauthenticationdata, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, jsonconfig, jsondata, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, setpagelanguage, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens

По умолчанию: 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-заголовка Cache-Control s-maxage в заданное число секунд. Ошибки никогда не кэшируются.

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

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

maxage

Установить значение HTTP-заголовка Cache-Control max-age в заданное число секунд. Ошибки никогда не кэшируются.

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

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

assert

Проверить, что участник авторизован, если задано user, или что он имеет права бота, если задано bot.

Одно из следующих значений: user, bot

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 и 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-тегами и замещёнными мнемониками.
wikitext: Нераспарсенный вики-текст.
html: HTML.
raw: Ключ сообщения и параметры.
none: Без текстового вывода, только коды ошибок.
bc: Формат, используемый до MediaWiki 1.29. errorlang и errorsuselocal игнорируются.

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

По умолчанию: 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
apihighlimits: Использовать высокие лимиты в запросах API (медленные запросы: 500, быстрые запросы: 5000). Лимиты для медленных запросов также применимы к параметрам со множеством значений.; Гарантируется: bot и sysop

| #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }} Шаблон:Clear {{#switch:<translate></translate> | =

Документация шаблона

Сюда включается текст, выводимый Special:ApiHelp/название-модуля, и объяснения того, что происходит.

Использование

1: название модуля. Нет ведущего пробела. Можно ссылаться на подмодули query через модуль+подмодуль

Пример

{{Api help|query+extracts}} produces

{{#switch:<translate></translate> | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

{{#switch: | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}

{{#switch:<translate></translate> | =

{{#if: {{#if:Нельзя включать справку по нескольким модулям API одновременно|Нельзя включать справку по нескольким модулям API одновременно|{{#if:|demo|}} }} |

Нельзя включать справку по нескольким модулям API одновременно

 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#switch:

| =

Нельзя включать справку по нескольким модулям API одновременно

 | Note Note: }}

| #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}

| #default=

 {{#switch:

| =

Документация шаблона

Сюда включается текст, выводимый Special:ApiHelp/название-модуля, и объяснения того, что происходит.

Использование

1: название модуля. Нет ведущего пробела. Можно ссылаться на подмодули query через модуль+подмодуль

Пример

{{Api help|query+extracts}} produces

{{#switch:<translate></translate> | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

{{#switch: | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}

{{#switch:<translate></translate> | =

Нельзя включать справку по нескольким модулям API одновременно

 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#switch:

| =

Нельзя включать справку по нескольким модулям API одновременно

 | Note Note: }}

| #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}

| #default=

 Ошибка Lua: expandTemplate: template loop detected.

}}{{#if:Сюда включается текст, выводимый Special:ApiHelp/название-модуля, и объяснения того, что происходит.

Использование

1: название модуля. Нет ведущего пробела. Можно ссылаться на подмодули query через модуль+подмодуль

Пример

{{Api help|query+extracts}} produces

{{#switch:<translate></translate> | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

{{#switch: | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}

{{#switch:<translate></translate> | =

Нельзя включать справку по нескольким модулям API одновременно

 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#switch:

| =

Нельзя включать справку по нескольким модулям API одновременно

 | Note Note: }}

| #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}| [[Category:Template documentation pages{{#translation:}}]] }} }}{{#if:Сюда включается текст, выводимый Special:ApiHelp/название-модуля, и объяснения того, что происходит.

Использование

1: название модуля. Нет ведущего пробела. Можно ссылаться на подмодули query через модуль+подмодуль

Пример

{{Api help|query+extracts}} produces

{{#switch:<translate></translate> | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

{{#switch: | =

Шаблон:Ombox

Модуль «query+extracts» не найден. | #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}

{{#switch:<translate></translate> | =

Нельзя включать справку по нескольким модулям API одновременно

 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#switch:

| =

Нельзя включать справку по нескольким модулям API одновременно

 | Note Note: }}

| #default=

 Ошибка Lua: expandTemplate: template loop detected.

}} }}| [[Category:Template documentation pages{{#translation:}}]] }}

[[Category:API templates{{#translation:}}|Api help/ru]]

Аноним

Поиск

Пространства имён

Ещё

Действия на странице

Главный модуль

Содержание

Использование

Пример

Использование

Пример

Использование

Пример

Использование

Пример

Навигация

Навигация

Другие ресурсы Vinteo

Аноним

Поиск

Шаблон:Api help/ru

Главный модуль

Содержание

Использование

Пример

Использование

Пример

Использование

Пример

Использование

Пример

Навигация

Инструменты для страниц

Категории