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
- Fonte: MediaWiki
- Licença: GPL-2.0+
Estado: Todas as funcionalidades mostradas nesta página devem ter o comportamento documentado mas a API ainda está em desenvolvimento ativo e pode ser alterada a qualquer momento. Inscreva-se na 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
A operação a ser realizada.
- 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, spamblacklist, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, visualeditor, visualeditoredit, watch
- Valor por omissão: help
- format
O formato do resultado.
- 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 site, 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-maxagede 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-agede 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çalhoOrigin, será devolvida a resposta 403. Se este parâmetro for igual ao cabeçalhoOrigine a origem for permitida (white-listed) os cabeçalhosAccess-Control-Allow-OrigineAccess-Control-Allow-Credentialsserão preenchidos.Para pedidos não autenticados, especifique o valor *. Isto fará com que o cabeçalho
Access-Control-Allow-Originseja preenchido, masAccess-Control-Allow-Credentialsterá o valorfalsee 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 MediaWiki.
- Tipo: booleano (detalhes)
- Ajuda para o módulo principal.
- api.php?action=help [abrir na página de testes]
- Toda a ajuda numa página.
- api.php?action=help&recursivesubmodules=1 [abrir na página de testes]
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 mediawiki-api@lists.wikimedia.org, ou reportar quaisquer defeitos que encontre em https://phabricator.wikimedia.org/.