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
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
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.
Testes: Para testar facilmente pedidos à API, visite Testes da API.
- action
Qual ação executar.
- block
- Bloquear um usuário.
- changeauthenticationdata
- Alterar os dados de autenticação para o usuário atual.
- checktoken
- Verificar a validade de um token de action=query&meta=tokens.
- clearhasmsg
- Limpa a etiqueta
hasmsg
do usuário atual. - 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.
- 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.
- edit
- Criar e editar páginas.
- emailuser
- Envia e-mail para o usuário.
- 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.
- help
- Mostra a ajuda para os módulos especificados.
- imagerotate
- Gira uma ou mais imagens.
- import
- Importar uma página de outra wiki ou de um arquivo XML.
- linkaccount
- Vincule uma conta de um provedor de terceiros ao usuário atual.
- login
- Faça login e obtenha cookies de autenticação.
- logout
- Faça o logout e limpe os dados da sessão.
- managetags
- Execute tarefas de gerenciamento relacionadas às tags de alteração.
- mergehistory
- Fundir históricos das páginas.
- move
- Mover uma página.
- 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.
- 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.
- 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).
- 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.
- tag
- Adicionar ou remover tags de alteração de revisões individuais ou entradas de log.
- 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.
- upload
- Carregue um arquivo ou obtenha o status dos carregamentos pendentes.
- userrights
- Alterar a associação de um grupo de usuários.
- validatepassword
- Valide uma senha de acordo as políticas de senha da wiki.
- watch
- Adicionar ou remover páginas da lista de páginas vigiadas do usuário atual.
- tokens
- Obsoleto. Obter tokens para ações de modificação de dados.
- Um dos seguintes valores: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, 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çalhoOrigin
, uma resposta 403 será retornada. Se este parâmetro corresponder ao cabeçalhoOrigin
e a origem for permitida (whitelisted), os cabeçalhosAccess-Control-Allow-Origin
eAccess-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 oAccess-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)
- Ajuda para o módulo principal.
- api.php?action=help [abrir na página de testes]
- Toda a ajuda em uma página.
- api.php?action=help&recursivesubmodules=1 [abrir na página de testes]
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.
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/.