Ajuda API da MediaWiki

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

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

Módulo principal

Estado: Todas as funcionalidades mostradas nesta página deveriam estar a funcionar, mas a API ainda está em activo desenvolvimento, e pode ser alterada a qualquer momento. Inscreva-se na lista de discussão mediawiki-api-announce para ser informado acerca das actualizações.

Solicitações erradas: Quando solicitações erradas são enviadas à API, um cabeçalho em HTTP será enviado com a chave "MediaWiki-API-Error" e, em seguida, tanto o valor do cabeçalho quanto o código de erro retornado serão definidos com o mesmo valor. Para mais informação, consulte API: Errors and warnings.

Testes: Para facilitar os testes de solicitações à API, consulte Special:ApiSandbox.

Parâmetros:
action

Qual ação executar.

Um dos seguintes valores: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, 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, stashedit, tag, tokens, unblock, undelete, unlinkaccount, upload, userrights, visualeditor, visualeditoredit, watch
Padrão: help
format

O formato da saída.

Um dos seguintes valores: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Padrão: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

Type: integer
smaxage

Define o cabeçalho s-maxage para esta quantidade de segundos. Os erros não são armazenados em cache.

Type: integer
Padrão: 0
maxage

Define o cabeçalho max-age para esta quantidade de segundos. Os erros não são armazenados em cache.

Type: integer
Padrão: 0
assert

Verify the user is logged in if set to user, or has the bot user right if bot.

Um dos seguintes valores: user, bot
requestid

Qualquer valor dado aqui será incluído na resposta. Pode ser usado para distinguir requisições.

servedby

Include the hostname that served the request in the results.

Tipo: boolean (detalhes)
curtimestamp

Inclui a data atual no resultado.

Tipo: boolean (detalhes)
origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.

uselang

Language to use for message translations. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify user to use the current user's language preference, or specify content to use this wiki's content language.

Padrão: user
Permissiões:
writeapi
Uso da API de escrita
Concedidas a: all, user, bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Concedidas a: bot, sysop

Tipo de dados

Some parameter types in API requests need further explanation:

boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now

Créditos

Programadores API:

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

Por favor, envie os seus comentários, sugestões e perguntas para mediawiki-api@lists.wikimedia.org ou reporte um erro técnico em https://phabricator.wikimedia.org/.