Ajuda da API do MediaWiki

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

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

Módulo principal

Estado: A API do MediaWiki é uma interface consolidada e estável que é constantemente suportada e melhorada. Embora tentemos evitá-lo, podemos ocasionalmente realizar alterações disruptivas. Inscreva-se na lista de distribuição mediawiki-api-announce para receber notificações 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

A operação a ser realizada.

abusefiltercheckmatch
Verifique se um filtro de abusos coincide com um conjunto de variáveis, evento do registo de abusos com editor registado.
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.
block
Bloquear um utilizador.
categorytree
Módulo interno para a extensão "Árvore de categorias" (CategoryTree).
changeauthenticationdata
Alterar os dados de autenticação do utilizador atual.
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.
cspreport
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.
delete
Eliminar uma página.
echomarkread
Marcar notificações como lidas para o utilizador atual.
echomarkseen
Marcar as notificações como vistas pelo utilizador atual.
edit
Criar e editar páginas.
editmassmessagelist
Editar uma lista de entrega de mensagens em massa.
emailuser
Enviar correio eletrónico a um utilizador.
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.
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.
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.
massmessage
Enviar uma mensagem para uma lista de páginas.
mergehistory
Fundir o historial de páginas.
mobileview
Devolve os dados necessários para o visionamento em dispositivos móveis.
move
Mover uma página.
multiupload-unpack
Descomprimir um ficheiro ZIP ou tar antes de importar o seu conteúdo.
oathvalidate
Validar uma chave de autenticação de dois fatores (OATH).
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).
scribunto-console
Módulo anterno pa respunder ls pedidos XHR benidos de la cunsuola Scribunto.
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.
spamblacklist
Validar um ou mais URL contra a lista negra de spam.
stashedit
Preparar uma edição na cache partilhada.
tag
Adicionar ou remover as etiquetas de modificação aplicadas a revisões individuais ou a entradas do registo.
thank
Enviar uma notificação de agradecimento a um editor.
titleblacklist
Validar um título de página, nome de ficheiro ou nome de utilizador contra a lista negra.
transcodereset
Os utilizadores com o privilégio 'transcode-reset' podem reiniciar e voltar a executar uma tarefa de transcodificação.
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.
watch
Adicionar ou remover páginas da lista de páginas vigiadas do utilizador atual.
webapp-manifest
Devolve um manifesto de aplicação web.
tokens
Obsoleto. Obter chaves para operações de modificação de dados.
Um dos seguintes valores: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, block, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, echomarkread, echomarkseen, edit, editmassmessagelist, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, massmessage, mergehistory, mobileview, move, multiupload-unpack, oathvalidate, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, setpagelanguage, spamblacklist, stashedit, tag, thank, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, tokens
Valor por omissão: help
format

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).
Um dos seguintes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Valor por omissão: jsonfm
maxlag

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.

Tipo: inteiro
smaxage

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

Tipo: inteiro
Valor por omissão: 0
maxage

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

Tipo: inteiro
Valor por omissão: 0
assert

Se definido com o valor user, verificar que o utilizador está autenticado. Se definido com o valor bot, verificar que o utilizador tem o privilégio de conta robô.

Um dos seguintes valores: user, bot
assertuser

Verificar que o utilizador atual é o utilizador nomeado.

Tipo: nome de utilizador
requestid

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

servedby

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

Tipo: booleano (detalhes)
curtimestamp

Incluir a data e hora atuais no resultado.

Tipo: booleano (detalhes)
responselanginfo

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

Tipo: booleano (detalhes)
origin

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 (white-listed) 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.

uselang

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

Valor por omissão: user
errorformat

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.
Um dos seguintes valores: plaintext, wikitext, html, raw, none, bc
Valor por omissão: bc
errorlang

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

Valor por omissão: uselang
errorsuselocal

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

Tipo: booleano (detalhes)
Permissões:
writeapi
Outelizar la API de scrita
Concedidas a: all, user i bot
apihighlimits
Usar limites mais altos em consultas da API (consultas lentas: 500; consultas rápidas: 5000). Os limites para consultas lentas também se aplicam a parâmetros com vários valores.
Concedidas a: bot i sysop

Tipo de dados

O formato de entrada para o MediaWiki deve ser UTF-8, normalizado de acordo com a norma NFC. O MediaWiki pode converter outros tipos de entrada, mas esta conversão pode originar a falha de algumas operações (tais como as edições com verificações MD5).

Alguns tipos de parâmetros nos pedidos à API necessitam de mais explicações:

boolean
Os parâmetros booleanos funcionam como as caixas de seleção HTML: se o parâmetro for especificado, independentemente do seu valor, é considerado verdadeiro. Para um valor falso, omitir o parâmetro completo.
timestamp
As datas e horas podem ser especificadas em vários formatos. É recomendado o formato ISO 8601. Todas as horas estão em UTC, qualquer inclusão do fuso horário é ignorada.
  • Data e hora ISO 8601, 2001-01-15T14:56:00Z (pontuação e Z são opcionais)
  • Data e hora ISO 8601 com segundos fracionários (estes são ignorados), 2001-01-15T14:56:00.00001Z (traços, dois pontos e Z são opcionais)
  • Formato do MediaWiki, 20010115145600
  • Formato numérico genérico, 2001-01-15 14:56:00 (fuso horário opcional GMT, +##, ou -## são ignorados)
  • 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 (o fuso horário pode ser omitido), Monday, 15-Jan-2001 14:56:00
  • Formato C ctime, Mon Jan 15 14:56:00 2001
  • Segundos desde 1970-01-01T00:00:00Z como um inteiro de 1 a 13 algarismos (excluindo 0)
  • O texto now
separador alternativo de valores múltiplos
Os parâmetros que aceitam vários valores são normalmente fornecidos com os valores separados por uma barra vertical (pipe), por exemplo parâmetro=valor1|valor2 ou parâmetro=valor1%7Cvalor2. Se um valor contém a barra vertical, use como separador o U+001F (Separador de Unidades) e prefixe o valor com U+001F, isto é, parâmetro=%1Fvalor1%1Fvalor2.

Créditos

Programadores da API:

  • Yuri Astrakhan (criador, programador principal, set 2006–set 2007)
  • Roan Kattouw (programador principal, set 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (programador principal, 2013–presente)

Pode enviar os seus comentários, sugestões e perguntas para o endereço [email protected], ou reportar quaisquer defeitos que encontre em https://phabricator.wikimedia.org/.