Ajuda da API MediaWiki

Esta é uma página de documentação da API MediaWiki gerada automaticamente.

Documentação e exemplos: https://www.mediawiki.org/wiki/API

Módulo principal

Estado: A API MediaWiki é uma interface madura e estável que é ativamente suportada e aprimorada. Enquanto tentamos evitá-lo, talvez ocortamente precisemos fazer mudanças de ruptura; se inscrever lista de discussão mediawiki-api-announce para ser informado acerca das atualizações.

Pedidos incorretos: Quando são enviados pedidos incorretos à API, será devolvido um cabeçalho HTTP com a chave "MediaWiki-API-Error" e depois tanto o valor desse cabeçalho como o código de erro devolvido serão definidos com o mesmo valor. Para mais informação, consulte API:Erros e avisos.

Parâmetros:
action

Qual ação executar.

adddomainalias
Add a domain alias to wiki
annotatewikinotspam
Marcar a Wiki como não spam
block
Bloquear um usuário.
categorytree
Módulo interno para a extensão "Árvore de categorias" (CategoryTree).
changeauthenticationdata
Alterar os dados de autenticação para o usuário atual.
checktoken
Verificar a validade de um token de action=query&meta=tokens.
checkwikistatus
Confere se o processo Criar Nova Wiki foi concluído e retorna o status de todo o processo, assim como os status de cada passo individual.
clearhasmsg
Limpa a etiqueta hasmsg do usuário atual.
clearwikiconfigcache
Limpar cache de configuração de uma wiki.
clientlogin
Faça o login no wiki usando o fluxo interativo.
compare
Obter a diferença entre duas páginas.
createaccount
Criar uma nova conta de usuário.
createnewwiki
Inicia o processo Criar Nova Wiki.
createwikiconfigvariabledefinition
Criar variável de configuração.
cspreport
Usado por navegadores para denunciar violações da Política de Segurança de Conteúdo. Este módulo nunca deve ser usado, exceto quando usado automaticamente por um navegador web compatível com CSP.
delete
Excluir uma página.
details
edit
Criar e editar páginas.
emailuser
Envia e-mail para o usuário.
embedvideo
Get generated video embed code for given parameters.
expandtemplates
Expande todas a predefinições em texto wiki.
feedcontributions
Retorna o feed de contribuições de um usuário.
feedrecentchanges
Retorna um feed de mudanças recentes.
feedwatchlist
Retornar um feed da lista de páginas vigiadas.
filerevert
Reverte um arquivo para uma versão antiga.
gettheme
help
Mostra a ajuda para os módulos especificados.
imagerotate
Gira uma ou mais imagens.
imageserving
This module is used to return one image URL for the specified article given either the article ID or article title (with prefix if applicable).
import
Importar uma página de outra wiki ou de um arquivo XML.
infobox
This module provides infobox parser
linkaccount
Vincule uma conta de um provedor de terceiros ao usuário atual.
linksuggest
Sugerir uma hiperligação aos editores no modo de edição
listusersnamesearch
listuserssearchuser
listwikiswithextension
Obter lista de wikis cujas extensões estão habilitadas.
listwikiswithvariable
Obter uma lista de wikis onde as variáveis estejam em um certo estado.
login
Faça login e obtenha cookies de autenticação.
logout
Faça o logout e limpe os dados da sessão.
lookupcontribs
Lookup user contributions
managetags
Execute tarefas de gerenciamento relacionadas às tags de alteração.
markwikiclosed
Marcar uma dada wiki como fechada (não disponível publicamente).
markwikiopen
Marcar uma dada wiki como aberta (disponível e pública).
markwikiprotected
Marcar uma dada wiki como protegida para que não seja possível fechá-la.
masseditwikis
Editar variáveis ​​de configuração para a lista de wikis.
mergehistory
Fundir históricos das páginas.
mobileview
Retorna os dados necessários para visualizações de dispositivos móveis.
modifydomainalias
Modify a domain alias to wiki
move
Mover uma página.
multidelete
multifindcharacter
notifications
Recuperar notificações para o usuário atual.
opensearch
Procure na wiki usando o protocolo OpenSearch.
options
Alterar as preferências do usuário atual.
paraminfo
Obter informações sobre módulos da API.
parse
Analisa o conteúdo e retorna a saída do analisador.
parsoid-batch
API Batch para o Parsoid
patrol
Patrulha uma página ou revisão.
protect
Modifica o nível de proteção de uma página.
purge
Limpe o cache para os títulos especificados.
query
Obtenha dados de e sobre o MediaWiki.
removeauthenticationdata
Remova os dados de autenticação para o usuário atual.
removedomainalias
Remove a domain alias to wiki
removephalanxblock
removewikiconfigvariable
Excluir a variável de configuração para a wiki.
reopenwiki
resetpassword
Envia um e-mail de redefinição de senha para o usuário atual.
revisiondelete
Excluir e recuperar revisões.
rollback
Desfazer a última edição para a página.
rsd
Exportar um esquema RSD (Really Simple Discovery).
savetheme
savewikiconfigvariable
Definir uma variável de configuração para a wiki.
schedulesearchindexupdate
scribunto-console
Módulo interno para atender solicitações XHR a partir do console Scribunto.
setnotificationtimestamp
Atualize o timestamp de notificação para páginas vigiadas.
setpagelanguage
Mudar o idioma de uma página.
stashedit
Prepare uma edição no cache compartilhado.
suggestwiki
suggestwikis
Obter lista de wikis cujos domínios contêm frase de busca.
tag
Adicionar ou remover tags de alteração de revisões individuais ou entradas de log.
tagsreport
templatedata
Obtenha dados armazenados pela extensão TemplateData.
titleblacklist
Valide um título de página, nome de arquivo ou nome de usuário no TitleBlacklist.
transcodereset
Os usuários com o direito 'transcode-reset' podem reiniciar e re-executar um trabalho de transcodificação.
unblock
Desbloquear usuário.
undelete
Restaure as revisões de uma página excluída.
unlinkaccount
Remova uma conta de terceiros vinculada ao usuário atual.
updateHubs
Atualizações de categorias e verticais da wiki
updateprimarydomain
Update primary domain of a wiki
updatewikiconfigvariabledefinition
Atualizar as propriedades da variável de configuração existente.
upload
Carregue um arquivo ou obtenha o status dos carregamentos pendentes.
uploadimage
userrights
Alterar a associação de um grupo de usuários.
validatepassword
Valide uma senha de acordo as políticas de senha da wiki.
variableinfo
Obter informação detalhada sobre dada configuração de variável.
variableupdate
Atualizar informação da variável
visualeditor
Retorna código HTML5 a uma página através do serviço Parsoid.
visualeditoredit
Salva uma página HTML5 em MediaWiki (convertida para texto wiki através do serviço Parsoid).
watch
Adicionar ou remover páginas da lista de páginas vigiadas do usuário atual.
webapp-manifest
Retorna um manifesto do webapp.
tokens
Obsoleto. Obter tokens para ações de modificação de dados.
Um dos seguintes valores: adddomainalias, annotatewikinotspam, block, categorytree, changeauthenticationdata, checktoken, checkwikistatus, clearhasmsg, clearwikiconfigcache, clientlogin, compare, createaccount, createnewwiki, createwikiconfigvariabledefinition, cspreport, delete, details, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, gettheme, help, imagerotate, imageserving, import, infobox, linkaccount, linksuggest, listusersnamesearch, listuserssearchuser, listwikiswithextension, listwikiswithvariable, login, logout, lookupcontribs, managetags, markwikiclosed, markwikiopen, markwikiprotected, masseditwikis, mergehistory, mobileview, modifydomainalias, move, multidelete, multifindcharacter, notifications, opensearch, options, paraminfo, parse, parsoid-batch, patrol, protect, purge, query, removeauthenticationdata, removedomainalias, removephalanxblock, removewikiconfigvariable, reopenwiki, resetpassword, revisiondelete, rollback, rsd, savetheme, savewikiconfigvariable, schedulesearchindexupdate, scribunto-console, setnotificationtimestamp, setpagelanguage, stashedit, suggestwiki, suggestwikis, tag, tagsreport, templatedata, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, updateHubs, updateprimarydomain, updatewikiconfigvariabledefinition, upload, uploadimage, userrights, validatepassword, variableinfo, variableupdate, visualeditor, visualeditoredit, watch, webapp-manifest, tokens
Padrão: help
format

O formato da saída.

json
Dados de saída em formato JSON.
jsonfm
Dados de saída no formato JSON (pretty-print em HTML).
none
Nenhuma saída.
php
Dados de saída no formato PHP serializado.
phpfm
Dados de saída em formato serializado em PHP (pretty-print em HTML).
rawfm
Dados de saída, incluindo elementos de depuração, no formato JSON (pretty-print em HTML).
xml
Dados de saída em formato XML.
xmlfm
Dados de saída em formato XML (impressão bonita em HTML).
Um dos seguintes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Padrão: jsonfm
maxlag

O atraso máximo pode ser usado quando o MediaWiki está instalado em um cluster replicado no banco de dados. Para salvar as ações que causam mais atraso na replicação do site, esse parâmetro pode fazer o cliente aguardar até que o atraso da replicação seja menor do que o valor especificado. Em caso de atraso excessivo, o código de erro maxlag é retornado com uma mensagem como Waiting for $host: $lag seconds lagged.
Veja Manual: Maxlag parameter para mais informações.

Tipo: inteiro
smaxage

Define o cabeçalho HTTP de controle de cache s-maxage para esta quantidade de segundos. Erros não são armazenados em cache.

Tipo: inteiro
Padrão: 0
maxage

Define o cabeçalho HTTP de controle de cache max-age para esta quantidade de segundos. Erros não são armazenados em cache.

Tipo: inteiro
Padrão: 0
assert

Verifique se o usuário está logado se configurado para user ou tem o direito do usuário do bot se bot.

Um dos seguintes valores: user, bot
assertuser

Verificar que o usuário atual é o utilizador nomeado.

Tipo: nome de usuário
requestid

Qualquer valor dado aqui será incluído na resposta. Pode ser usado para distinguir requisições.

servedby

Incluir nos resultados o nome do servidor que serviu o pedido.

Tipo: boleano (details)
curtimestamp

Inclui o timestamp atual no resultado.

Tipo: boleano (details)
responselanginfo

Inclua os idiomas usados para uselang e errorlang no resultado.

Tipo: boleano (details)
origin

Ao acessar a API usando uma solicitação AJAX por domínio cruzado (CORS), defina isto como o domínio de origem. Isto deve estar incluso em toda solicitação pre-flight, sendo portanto parte do URI da solicitação (ao invés do corpo do POST).

Para solicitações autenticadas, isto deve corresponder a uma das origens no cabeçalho Origin, para que seja algo como https://pt.wikipedia.org ou https://meta.wikimedia.org. Se este parâmetro não corresponder ao cabeçalho Origin, uma resposta 403 será retornada. Se este parâmetro corresponder ao cabeçalho Origin e a origem for permitida (whitelisted), os cabeçalhos Access-Control-Allow-Origin e Access-Control-Allow-Credentials serão definidos.

Para solicitações não autenticadas, especifique o valor *. Isto fará com que o cabeçalho Access-Control-Allow-Origin seja definido, porém o Access-Control-Allow-Credentials será false e todos os dados específicos para usuários tornar-se-ão restritos.

uselang

Linguagem a ser usada para traduções de mensagens. action=query&meta=siteinfo com siprop=languages retorna uma lista de códigos de idioma ou especifique user para usar a preferência de idioma do usuário atual ou especifique content para usar o idioma de conteúdo desta wiki.

Padrão: user
errorformat

Formato a ser usado aviso e saída de texto de erro.

Texto simples
Texto wiki com tags HTML removidas e entidades substituídas.
Wikitext
Unparsed wikitext.
html
HTML.
Bruto
chave e parâmetros da mensagem.
Nenhum
sem saída de texto, apenas os códigos de erro.
Bc
Formato usado antes do MediaWiki 1.29. errorlang e errorsuselocal são ignorados.
Um dos seguintes valores: plaintext, wikitext, html, raw, none, bc
Padrão: bc
errorlang

Linguagem a utilizar para avisos e erros. action=query&meta=siteinfo com siprop=languages retorna uma lista de códigos de idioma ou especifique content para usar o idioma do conteúdo desta wiki ou especifique uselang para usar o mesmo valor que o parâmetro uselang.

Padrão: uselang
errorsuselocal

Se for dado, os textos de erro usarão mensagens customizadas localmente a partir do espaço nominal MediaWiki.

Tipo: boleano (details)
Permissões:
writeapi
Uso da API de escrita
Concedidos a: all, user e bot
apihighlimits
Use limites mais altos nas consultas da API (consultas lentas: 500; consultas rápidas: 5000). Os limites para consultas lentas também se aplicam a parâmetros multivalores.
Concedidos a: bot, sysop, staff, helper, soap, wiki-representative e wiki-specialist

Tipos de dados

A entrada para MediaWiki deve ser UTF-8 normalizada pelo NFC. O MediaWiki pode tentar converter outra entrada, mas isso pode causar a falha de algumas operações (como editar com verificações MD5).

Alguns tipos de parâmetros em solicitações de API precisam de uma explicação adicional:

boolean
Os parâmetros booleanos funcionam como caixas de seleção HTML: se o parâmetro for especificado, independentemente do valor, é considerado verdadeiro. Para um valor falso, omita o parâmetro inteiramente.
timestamp
As marcas de tempo podem ser especificadas em vários formatos. É recomendada a data e a hora ISO 8601. Todos os horários estão em UTC, qualquer fuso horário incluído é ignorado.
  • Data e hora ISO 8601, 2001-01-15T14:56:00Z (pontuação e Z são opcionais)
  • ISO 8601 data e hora com segundos fracionados (ignorados), 2001-01-15T14:56:00.00001Z (traços, dois pontos e Z são opcionais)
  • Formato MediaWiki, 20010115145600
  • Formato numérico genérico, 2001-01-15 14:56:00 (fuso horário opcional de GMT, +## ou -## é ignorado)
  • Formato EXIF, 2001:01:15 14:56:00
  • Formato RFC 2822 (o fuso horário pode ser omitido), Mon, 15 Jan 2001 14:56:00
  • Formato RFC 850 (fuso horário Pode ser omitido), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Segundos desde 1970-01-01T00:00:00Z como um inteiro de 1 a 13 dígitos (excluindo 0)
  • A string now
valor múltiplo alternativo separador
Os parâmetros que levam vários valores são normalmente enviados com os valores separados usando o caractere do pipe, por exemplo param=value1|value2 ou param=value1%7Cvalue2. Se um valor deve conter o caractere de pipe, use U+001F (separador de unidade) como o separador and prefixa o valor com U+001F, por exemplo, param=%1Fvalue1%1Fvalue2.

Parâmetros da predefinição

Os parâmetros modelados usam-se nos casos em que um módulo da API necessita de um valor para cada valor de um outro parâmetro. Por exemplo, se existisse um módulo da API para encomendar fruta, poderia ter um parâmetro frutas para especificar as frutas que estão a ser encomendadas e um parâmetro modelado quantidade-de-{fruta} para especificar quanto de cada fruta. Um cliente da API que pretenda 1 maçã, 5 bananas e 20 morangos pode então fazer um pedido como frutas=maçãs|bananas|morangos&quantidade-de-maçãs=1&quantidade-de-bananas=5&quantidade-de-morangos=20.

Créditos

Desenvolvedores da API:

  • Yuri Astrakhan (criador, desenvolvedor-chefe Set 2006–Set 2007)
  • Roan Kattouw (desenvolvedor-chefe Set 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (desenvolvedor-chefe 2013–presente)

Por favor, envie seus comentários, sugestões e perguntas para mediawiki-api@lists.wikimedia.org ou apresente um relatório de erro em https://phabricator.wikimedia.org/.