Ajuda API da MediaWiki
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: 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.
- action
Qual acção a executar.
- One value: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
- Padrão: help
- format
O formato de saída.
- One value: dbg, dbgfm, dump, dumpfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm
- 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.- smaxage
Set the
s-maxageheader to this many seconds. Errors are never cached.- Padrão: 0
- maxage
Set the
max-ageheader to this many seconds. Errors are never cached.- Padrão: 0
- assert
Verify the user is logged in if set to user, or has the bot userright if bot.
- One value: 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.
- curtimestamp
Include the current timestamp in the result.
- 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
Originheader 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 theOriginheader, a 403 response will be returned. If this parameter matches theOriginheader and the origin is whitelisted, anAccess-Control-Allow-Originheader will be set.- uselang
Language to use for message translations. A list of codes may be fetched from action=query&meta=siteinfo with siprop=languages, or specify user to use the current user's language preference, or specify content to use this wiki's content language.
- Padrão: user
- Ajuda para o módulo principal
- api.php?action=help
- Toda a ajuda numa página
- api.php?action=help&recursivesubmodules=1
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/.