Ajuda da API do MediaWiki

A operação a ser realizada.

abusefiltercheckmatch

Verificar se um filtro de abusos coincide com um conjunto de variáveis, uma edição, ou um evento do registo de abusos.

abusefilterchecksyntax

Verificar a sintaxe de um filtro de abusos.

abusefilterevalexpression

Avalia uma expressão do filtro de abusos.

abusefilterunblockautopromote

Desbloqueia um utilizador de receber autopromoções em consequência do filtro de abusos.

abuselogprivatedetails

Ver detalhes privados de uma entrada do registo de abusos.

acquiretempusername

Adquirir um nome de utilizador para um utilizador temporário e armazená-lo na sessão atual, se a criação de contas temporárias estiver ativada e o utilizador atual não tiver sessão iniciada. Se já tiver sido armazenado um nome, devolve esse nome.

antispoof

Verificar um nome de utilizador contra as verificações de normalização do AntiSpoof.

block

Bloquear um utilizador.

centralauthtoken

Obter uma chave centralauthtoken para fazer um pedido autenticado a uma wiki anexada.

changeauthenticationdata

Alterar os dados de autenticação do utilizador atual.

changecontentmodel

Alterar o modelo de conteúdo de uma página

checktoken

Verificar a validade de uma chave a partir de action=query&meta=tokens.

clearhasmsg

Limpa a indicação hasmsg do utilizador atual.

clientlogin

Entrar na wiki usando o processo interativo.

compare

Obter a diferença entre duas páginas.

createaccount

Criar uma conta de utilizador nova.

createlocalaccount

Forçar a criação de uma conta local. A conta central tem de existir.

delete

Eliminar uma página.

deleteglobalaccount

Eliminar um utilizador global.

echomarkread

Marcar notificações como lidas para o utilizador atual.

echomarkseen

Marcar as notificações como vistas pelo utilizador atual.

echomute

Silenciar ou remover o silenciamento de notificações originadas por certos utilizadores ou páginas.

edit

Criar e editar páginas.

emailuser

Enviar correio eletrónico a um utilizador.

embedvideo

Obter o código de incorporação de vídeo gerado para os parâmetros fornecidos.

expandtemplates

Expande todas as predefinições existentes num texto wiki.

feedcontributions

Devolve um feed das contribuições do utilizador.

feedrecentchanges

Devolve um feed das mudanças recentes.

feedwatchlist

Devolve um feed das páginas vigiadas.

filerevert

Reverter um ficheiro para uma versão antiga.

globalblock

Bloquear ou desbloquear globalmente um utilizador.

globaluserrights

Adicionar ou remover um utilizador, de grupos globais.

help

Apresentar ajuda para os módulos especificados.

imagerotate

Rodar uma ou mais imagens.

import

Importar uma página de outra wiki ou de um ficheiro XML.

languagesearch

Pesquisar nomes de línguas em qualquer sistema de escrita.

linkaccount

Ligar uma conta de um fornecedor terceiro ao utilizador atual.

login

Iniciar uma sessão e obter cookies de autenticação.

logout

Terminar a sessão e limpar os dados da sessão.

managetags

Executar tarefas de gestão relacionadas com etiquetas de modificação.

mergehistory

Fundir o historial de páginas.

move

Mover uma página.

opensearch

Pesquisar a wiki usando o protocolo OpenSearch.

options

Alterar as preferências do utilizador atual.

paraminfo

Obter informação sobre os módulos da API.

parse

Faz a análise sintática do conteúdo e devolve o resultado da análise.

patrol

Patrulhar uma página ou revisão.

protect

Alterar o nível de proteção de uma página.

purge

Limpar a cache para os títulos especificados.

query

Obter dados de, e sobre, o MediaWiki.

removeauthenticationdata

Remover os dados de autenticação do utilizador atual.

resetpassword

Enviar a um utilizador uma mensagem eletrónica de reinício da palavra-passe.

revisiondelete

Eliminar e restaurar revisões.

rollback

Desfazer a última edição da página.

rsd

Exportar um esquema (schema) RSD (Really Simple Discovery).

setglobalaccountstatus

Ocultar ou bloquear (ou revelar ou desbloquear) uma conta de utilizador global.

setnotificationtimestamp

Atualizar a data e hora de notificação de alterações às páginas vigiadas.

setpagelanguage

Alterar a língua de uma página.

tag

Adicionar ou remover as etiquetas de modificação aplicadas a revisões individuais ou a entradas do registo.

templatedata

Obtém dados armazenados pela extensão TemplateData.

thank

Enviar uma notificação de agradecimento a um editor.

unblock

Desbloquear um utilizador.

undelete

Restaurar revisões de uma página eliminada.

unlinkaccount

Remover do utilizador atual uma conta ligada de uma wiki terceira.

upload

Carregar um ficheiro, ou obter o estado dos carregamentos pendentes.

userrights

Alterar os grupos a que um utilizador pertence.

validatepassword

Validar uma palavra-passe face às regras para palavras-passe da wiki.

voteny

Módulo da API VoteNY

watch

Adicionar ou remover páginas da lista de páginas vigiadas do utilizador atual.

webapp-manifest

Devolve um manifesto de aplicação da Internet.

categorytree

Interno. Módulo interno para a extensão "Árvore de categorias" (CategoryTree).

cspreport

Interno. Usado por browsers para reportar violações da norma "Content Security Policy". Este módulo nunca deve ser usado, exceto quando utilizado automaticamente por um browser compatível com a CSP.

editcheckreferenceurl

Interno. Check the status of a URL for use as a reference.

scribunto-console

Interno. Módulo interno para responder a pedidos XHR vindos da consola Scribunto.

stashedit

Interno. Preparar uma edição na cache partilhada.

ulslocalization

Interno. Obter a localização de ULS na língua indicada.

ulssetlang

Interno. Atualizar a língua de interface preferida do utilizador.

visualeditor

Interno. Devolve o HTML5 para uma página a partir do serviço Parsoid.

visualeditoredit

Interno. Gravar no MediaWiki uma página HTML5 (convertida para texto wiki através do serviço Parsoid).

O formato do resultado.

json

Produzir os dados de saída no formato JSON.

jsonfm

Produzir os dados de saída em formato JSON (realce sintático em HTML).

none

Não produzir nada.

php

Produzir os dados de saída em formato PHP seriado.

phpfm

Produzir os dados de saída em formato PHP seriado (realce sintático em HTML).

rawfm

Produzir os dados de saída, incluindo elementos para despiste de erros, em formato JSON (realce sintático em HTML).

xml

Produzir os dados de saída em formato XML.

xmlfm

Produzir os dados de saída em formato XML (realce sintático em HTML).

O atraso máximo pode ser usado quando o MediaWiki é instalado num cluster de bases de dados replicadas. Para impedir que as operações causem ainda mais atrasos de replicação do sítio, este parâmetro pode fazer o cliente aguardar até que o atraso de replicação seja inferior ao valor especificado. Caso o atraso atual exceda esse valor, o código de erro maxlag é devolvido com uma mensagem como À espera do servidor $host: $lag segundos de atraso.
Consulte Manual: Parâmetro maxlag para mais informações.

Definir no cabeçalho HTTP s-maxage de controlo da cache este número de segundos. Os erros nunca são armazenados na cache.

Definir no cabeçalho HTTP max-age de controlo da cache este número de segundos. Os erros nunca são armazenados na cache.

Verificar que o utilizador tem sessão iniciada (inclusive possivelmente como utilizador temporário) se definido como user, que não tem sessão iniciada se definido como anon ou que tem o direito de utilizador de robô se bot.

Verificar que o utilizador atual é o utilizador nomeado.

Qualquer valor fornecido aqui será incluído na resposta. Pode ser usado para distinguir pedidos.

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

Incluir a data e hora atuais no resultado.

Incluir as línguas usadas para uselang e errorlang no resultado.

Ao aceder à API usando um pedido AJAX entre domínios (CORS), coloque aqui o domínio de origem. Isto tem de ser incluído em todas as verificações prévias e, portanto, tem de fazer parte do URI do pedido (e não do conteúdo do POST).

Para pedidos autenticados, este valor tem de corresponder de forma exata a um dos cabeçalhos Origin, portanto, tem de ser algo como https://en.wikipedia.org ou https://meta.wikimedia.org. Se este parâmetro não for igual ao cabeçalho Origin, será devolvida a resposta 403. Se este parâmetro for igual ao cabeçalho Origin e a origem for permitida, os cabeçalhos Access-Control-Allow-Origin e Access-Control-Allow-Credentials serão preenchidos.

Para pedidos não autenticados, especifique o valor *. Isto fará com que o cabeçalho Access-Control-Allow-Origin seja preenchido, mas Access-Control-Allow-Credentials terá o valor false e o acesso a todos os dados específicos do utilizador está restringido.

A língua a ser usada nas traduções de mensagens. action=query&meta=siteinfo&siprop=languages devolve uma lista de códigos de língua. Pode especificar user para usar a língua nas preferências do utilizador atual ou content para usar a língua de conteúdo desta wiki.

Variante da língua. Só funciona se a língua de base suportar a conversão de variantes.

O formato a ser usado no texto de avisos e erros

plaintext

Texto wiki com os elementos HTML removidos e as entidades substituídas.

wikitext

Texto wiki sem análise sintática.

html

HTML

raw

Chave e parâmetros da mensagem.

none

Sem saída de texto, só os códigos de erro.

bc

Formato usado antes do MediaWiki 1.29. errorlang e errorsuselocal são ignorados.

A língua a ser usada para avisos e erros. action=query&meta=siteinfo&siprop=languages devolve uma lista de códigos de língua. Especificar content para usar a língua de conteúdo desta wiki ou uselang para usar o mesmo valor que o parâmetro uselang.

Se fornecido, os textos de erro utilizarão mensagens personalizadas localmente do espaço nominal MediaWiki.

Ao aceder à API usando um pedido AJAX entre domínios (CORS), use este parâmetro para se autenticar como o utilizador SUL atual. Use action=centralauthtoken nesta wiki para obter a chave, antes de efetuar o pedido CORS. Cada chave só pode ser usada uma vez e expira após 10 segundos. Isto tem de ser incluído em todas as verificações prévias, e portanto tem de fazer parte do URI do pedido (e não do conteúdo do POST).