Шаблон:Api help/pt

Материал из База знаний VINTEO

<languages/>

{{#switch: | =

Шаблон:Ombox

| #default=

{{#switch: | =

Шаблон:Ombox

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

Specify the action to perform, the format of the response, and options that apply to all API modules.

Определённые параметры:
action

Действие, которое необходимо выполнить. Этот параметр должен передаваться как часть URL-адреса запроса (а не в теле POST-запроса) для упрощения отладки, аналитики и маршрутизации или фильтрации запроса.

acquiretempusername
Получить временное имя пользователя и сохраните его в текущем сеансе, если создание временной учётной записи включено и текущий пользователь вышел из системы. Если имя уже сохранено, возвращается то же имя.
block
Блокировка участника.
changeauthenticationdata
Смена параметров аутентификации для текущего участника.
changecontentmodel
Изменить модель содержимого страницы
checktoken
Проверить действительность токена из action=query&meta=token.
clearhasmsg
Очистить флаг hasmsg для текущего участника.
clientlogin
Вход в вики с помощью интерактивного потока.
compare
Получение разницы между двумя страницами.
createaccount
Создание новой учётной записи.
delete
Удаление страницы.
edit
Создание и редактирование страниц.
emailuser
Написание электронных писем участнику.
embedvideo
Получить код для встраивания видео с учётом заданных параметров.
expandtemplates
Разворачивание всех шаблонов в вики-текст.
feedcontributions
Возвращает ленту с вкладом участников.
feedrecentchanges
Возвращает ленту последних изменений.
feedwatchlist
Возвращает ленту списка наблюдения.
filerevert
Возвращение файла к старой версии.
help
Отображение справки указанных модулей.
imagerotate
Поворот одного или нескольких изображений.
import
Импорт страницы из другой вики или XML-файла.
jsonconfig
Обеспечивает прямой доступ к подсистеме JsonConfig.
languagesearch
Поиск названий языков на любом алфавите.
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).
setnotificationtimestamp
Обновление временной метки уведомления для отслеживаемых страниц.
setpagelanguage
Изменить язык страницы.
tag
Добавление или удаление меток отдельных правок или записей журналов.
unblock
Разблокировка участника.
undelete
Восстановление версий удалённой страницы.
unlinkaccount
Удаление связанного стороннего аккаунта с текущим участником.
upload
Загрузка файла или получение статуса незавершённых загрузок.
userrights
Изменение групп участника.
validatepassword
Проверка пароля на удовлетворение политики вики.
watch
Добавление или удаление страниц из списка наблюдения текущего участника.
cspreport
Внутренний. Используется браузерами, чтобы сообщать о нарушениях политики безопасности (CSP). Этот модуль никогда не должен использоваться, за исключением случаев автоматического использования совместимыми с CSP браузерами.
jsondata
Внутренний. Вызывает локализованные JSON-данные.
scribunto-console
Внутренний. Внутренний модуль для обработки XHR-запросов из консоли Scribunto.
stashedit
Внутренний. Подготовка правки в общем кэше.
Одно из следующих значений: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, jsondata, scribunto-console, stashedit
По умолчанию: 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.
По умолчанию: 0
maxage

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

Тип: целочисленное значение
Значение должно быть не меньше 0.
По умолчанию: 0
assert

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

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

Проверить, что ник текущего участника совпадает с заданным.

Тип: пользователь, любой из имя участника и Временный участник
requestid

Любое заданное здесь значение будет включено в ответ. Может быть использовано для различения запросов.

servedby

Включить в результаты имя сервера, обработавшего запрос.

Тип: булева (подробнее)
curtimestamp

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

Тип: булева (подробнее)
responselanginfo

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

Тип: булева (подробнее)
origin

При обращении к API с использованием кроссдоменного AJAX-запроса (CORS), задайте параметру значение исходного домена. Этот параметр должен быть включён в любой предварительный запрос и таким образом должен быть частью URL запроса (не тела 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 и все пользовательские данные будут ограничены.

crossorigin

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

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

Тип: булева (подробнее)
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.

Тип: булева (подробнее)
Примеры:
Помощь по главному модулю.
api.php?action=help [открыть в песочнице]
Вся справка на одной странице.
api.php?action=help&recursivesubmodules=1&toc [открыть в песочнице]

| #default= 

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

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

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

Isto transpõem Special:ApiHelp/"module-name" (Especial:Ajuda da Api/"nome do módulo") e explica o que está a acontecer.

Utilização

1
nome do módulo. Nenhum espaço à esquerda. Pode fazer referência aos submódulos de consulta por "módulo" + "submódulo"

Amostra

{{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:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default= 

 {{#switch:

| =

{{#if: {{#if:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | Note Note: }}

| #default= 

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

}} }}

Редакторы могут поэкспериментировать в песочнице (ред. | різниця) или тестовый (ред.).
Посмотреть все подстраницы этого шаблона.

| #default= 

 {{#switch:

| =

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

Isto transpõem Special:ApiHelp/"module-name" (Especial:Ajuda da Api/"nome do módulo") e explica o que está a acontecer.

Utilização

1
nome do módulo. Nenhum espaço à esquerda. Pode fazer referência aos submódulos de consulta por "módulo" + "submódulo"

Amostra

{{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:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default= 

 {{#switch:

| =

{{#if: {{#if:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | Note Note: }}

| #default= 

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

}} }}

Редакторы могут поэкспериментировать в песочнице (ред. | різниця) или тестовый (ред.).
Посмотреть все подстраницы этого шаблона.

| #default= 

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

}}{{#if:Isto transpõem Special:ApiHelp/"module-name" (Especial:Ajuda da Api/"nome do módulo") e explica o que está a acontecer.

Utilização

1
nome do módulo. Nenhum espaço à esquerda. Pode fazer referência aos submódulos de consulta por "módulo" + "submódulo"

Amostra

{{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:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default= 

 {{#switch:

| =

{{#if: {{#if:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | Note Note: }}

| #default= 

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

}} }}| [[Category:Template documentation pages{{#translation:}}]] }} }}{{#if:Isto transpõem Special:ApiHelp/"module-name" (Especial:Ajuda da Api/"nome do módulo") e explica o que está a acontecer.

Utilização

1
nome do módulo. Nenhum espaço à esquerda. Pode fazer referência aos submódulos de consulta por "módulo" + "submódulo"

Amostra

{{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:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default= 

 {{#switch:

| =

{{#if: {{#if:Não pode transpor a ajuda de vários módulos da API de uma só vez|Não pode transpor a ajuda de vários módulos da API de uma só vez|{{#if:|demo|}} }} |
Não pode transpor a ajuda de vários módulos da API de uma só vez
 | Note Note: }}

| #default= 

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

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

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

Источник — https://wiki.vinteo.com/index.php?title=Шаблон:Api_help/pt&oldid=654