Ajuda da API do MediaWiki

A operação a ser realizada.

block

Bloquear um utilizador.

bs-adminuser-store

Lista todos os utilizadores da base de dados com dados confidenciais adicionais. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-avatars-tasks

Carregar, gerar e definir imagens de perfil dos utilizadores

bs-category-store

Lista todas as categorias. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-category-treestore

Lista as subcategorias de uma categoria específica

bs-checklist-available-options-store

Lista todas as opções disponíveis para os modelos de listas de verificação. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-checklist-tasks

Fornece operações para a extensão Checklist

bs-checklist-template-store

Listas todos os modelos que são fontes válidas de listas de verificação. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-configmanager-store

Gerir armazenamento

bs-configmanager-tasks

Gerir tarefas

bs-contextmenu-tasks

Fornece os elementos do menu contextual no contexto

bs-dashboards-store

Lista todos os portlets disponíveis

bs-dashboards-tasks

Grava a configuração do painel

bs-dashboards-widgets-tasks

Devolve conteúdo para alguns widgets de painel

bs-filebackend-store

Lista todos os ficheiros do servidor de ficheiros. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-group-store

Lista todos os grupos exceto $wgImplicitGroups. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-groupmanager

Fornece as tarefas para a extensão Gestor de grupos.

bs-insertfile-license-store

Lista as licenças para a extensão InsertFile.

bs-insertmagic-data-store

Lista todos os elementos para o diálogo InsertMagic

bs-interwiki-store

Lista todas as hiperligações interwikis. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-interwikilinks-tasks

Fornece as tarefas para a extensão InterWikiLinks.

bs-mypageassignment-store

Devolve as páginas atribuídas ao utilizador atual

bs-namespace-store

Lista todos os domínios e configurações arbitrárias. Permite ordenação, filtragem e paginação. Implementa parâmetros ExtJS Store.

bs-namespace-tasks

Permite a modificação da configuração dos espaços nominais.

bs-namespacecss-store

Lista os espaços nominais e a possível página de origem do seu CSS. Implementa os parâmetros ExtJS Store.

bs-pageaccess-store

Controla o acesso ao nível da página

bs-pageassignable-store

Devolve a lista daqueles a quem foram atribuídas páginas

bs-pageassignment-store

Devolve as atribuições da página específica

bs-pageassignment-tasks

Obter ou editar a lista de atribuições para uma página específica

bs-pagetemplates-store

Lista todos os modelos de página. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-pagetemplates-tasks

Permite a manipulação dos modelos de página

bs-permissionmanager-tasks

Fornece tarefas para o PermissionManager

bs-ping-tasks

Tarefa de ping que permite a troca contínua de dados

bs-readers-data-store

Obter informação de um leitor de uma página específica.

bs-readers-page-readers-store

Obter todos os leitores de todas as páginas

bs-readers-users-store

Obter informação de todos os leitores de uma página específica.

bs-recentchanges-store

Lista todas as mudanças recentes. Permite ordenar, filtrar e paginar. Implementa os parâmetros store.

bs-role-permission-store

Fornecer descrição de função para o PermissionManager

bs-rss-standards-pages-store

Devolver lista das páginas disponíveis para o RSSFeeder

bs-rssfeeder-tasks

Fornece tarefas comuns para o RSSFeeder

bs-smartlist-tasks

Funções da API para servir dados a portlets de estatísticas de páginas e de utilizadores.

bs-statistics-available-diagrams-store

Fornece armazenamento com diagramas disponíveis

bs-statistics-search-options-store

Fornece armazenamento com opções de pesquisa disponíveis

bs-statistics-tasks

Fornece tarefas comuns para estatísticas

bs-titlequery-store

Lista títulos de páginas e (opcionalmente) prefixos dos domínios, com base num termo de pesquisa. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-upload-license-store

Lista todas as licenças disponíveis para o carregamento de um ficheiro

bs-usagetracker-store

Contém dados estatísticos sobre o uso da extensão

bs-user-store

Lista todos os utilizadores da base de dados. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-usermanager-group-store

Fornece a API de tarefas de gestão do utilizador para o BlueSpice.

bs-usermanager-tasks

Fornece operações para a extensão Checklist

bs-watchlist-store

Lista todas as entradas da lista de páginas vigiadas. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-wikipage-store

Lista todas as páginas da wiki. Permite ordenar, filtrar e paginar. Implementa os parâmetros ExtJS Store.

bs-wikipage-tasks

Fornece operações comuns para páginas da wiki

bs-wikisubpage-treestore

Lista as subpáginas de uma página wiki específica

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.

emailuser

Enviar correio eletrónico a um utilizador.

embedvideo

⧼apihelp-embedvideo-summary⧽

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.

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).

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.

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.

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.

tokens

Obsoleto. Obter chaves para operações de modificação de dados.

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.

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ô.

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 (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.

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.

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 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.

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