MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Modulo principale

Stato: l'API MediaWiki è un'interfaccia matura e stabile che è attivamente supportata e migliorata. Anche se cerchiamo di evitarlo, potremmo dover fare delle modifiche che causano malfunzionamenti; iscriviti alla mailing list sugli annunci delle API MediaWiki per essere informato sugli aggiornamenti.

Istruzioni sbagliate: quando vengono impartite alle API delle istruzioni sbagliate, un'intestazione HTTP verrà inviata col messaggio "MediaWiki-API-Error" e, sia il valore dell'intestazione, sia il codice d'errore, verranno impostati con lo stesso valore. Per maggiori informazioni leggi API:Errori ed avvertimenti (in inglese).

Parametri:
action

Azione da compiere.

block
Blocca un utente.
changeauthenticationdata
Modificare i dati di autenticazione per l'utente corrente.
changecontentmodel
Change the content model of a page
checktoken
Verifica la validità di un token da action=query&meta=tokens.
clearhasmsg
Cancella il flag hasmsg per l'utente corrente.
clientlogin
Accedi al wiki utilizzando il flusso interattivo.
compare
Ottieni le differenze tra 2 pagine.
createaccount
Crea un nuovo account utente.
delete
Cancella una pagina.
edit
Crea e modifica pagine.
emailuser
Manda un'e-mail ad un utente.
expandtemplates
Espande tutti i template all'interno del wikitesto.
feedcontributions
Returns a user's contributions feed.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
Returns a watchlist feed.
filerevert
Ripristina un file ad una versione precedente.
help
Mostra la guida per i moduli specificati.
imagerotate
Ruota una o più immagini.
import
Import a page from another wiki, or from an XML file.
linkaccount
Collegamento di un'utenza di un provider di terze parti all'utente corrente.
login
Accedi e ottieni i cookie di autenticazione.
logout
Esci e cancella i dati della sessione.
managetags
Perform management tasks relating to change tags.
mergehistory
Unisce cronologie pagine.
move
Sposta una pagina.
opensearch
Search the wiki using the OpenSearch protocol.
options
Change preferences of the current user.
paraminfo
Ottieni informazioni sui moduli API.
parse
Parses content and returns parser output.
patrol
Verifica una pagina o versione.
protect
Modifica il livello di protezione di una pagina.
purge
Pulisce la cache per i titoli indicati.
query
Fetch data from and about MediaWiki.
removeauthenticationdata
Rimuove i dati di autenticazione per l'utente corrente.
resetpassword
Invia una mail per reimpostare la password di un utente.
revisiondelete
Cancella e ripristina le versioni.
rollback
Undo the last edit to the page.
rsd
Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Cambia la lingua di una pagina.
spamblacklist
Validate one or more URLs against the SpamBlacklist.
tag
Add or remove change tags from individual revisions or log entries.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
unblock
Sblocca un utente
undelete
Ripristina versioni di una pagina cancellata.
unlinkaccount
Rimuove un'utenza di terze parti collegata all'utente corrente.
upload
Upload a file, or get the status of pending uploads.
userrights
Change a user's group membership.
validatepassword
Convalida una password seguendo le politiche del wiki sulle password.
watch
Aggiunge o rimuove pagine dagli osservati speciali dell'utente attuale.
cspreport
Internal. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
stashedit
Internal. Prepare an edit in shared cache.
visualeditor
Internal. Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Internal. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
Uno dei seguenti valori: block, changeauthenticationdata, changecontentmodel, 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, setpagelanguage, spamblacklist, tag, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit, visualeditor, visualeditoredit
Default: help
format

Formato dell'output.

json
Output data in JSON format.
jsonfm
Output data in JSON format (pretty-print in HTML).
none
Output nothing.
php
Output data in serialized PHP format.
phpfm
Output data in serialized PHP format (pretty-print in HTML).
rawfm
Output data, including debugging elements, in JSON format (pretty-print in HTML).
xml
Output data in XML format.
xmlfm
Output data in XML format (pretty-print in HTML).
Uno dei seguenti valori: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Default: 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

Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
Default: 0
maxage

Set the max-age HTTP cache control header to this many seconds. Errors are never cached.

Type: integer
Default: 0
assert

Verifica che l'utente abbia effettuato l'accesso se si è impostato user, non abbia effettuato l'accesso se si è impostato anon o che abbia i permessi di bot se si è impostato bot.

Uno dei seguenti valori: anon, bot, user
assertuser

Verify the current user is the named user.

Type: user, by nome utente
requestid

Tutti i valori forniti saranno implementati nella risposta. Potrebbero venir utilizzati per distinguere le richieste.

servedby

Includi nel risultato il nome dell'host che ha servito la richiesta.

Tipo: booleano (dettagli)
curtimestamp

Includi nel risultato il timestamp attuale.

Tipo: booleano (dettagli)
responselanginfo

Include the languages used for uselang and errorlang in the result.

Tipo: booleano (dettagli)
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).

For authenticated requests, 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 allowed, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

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.

Default: user
errorformat

Format to use for warning and error text output

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML
raw
Message key and parameters.
none
No text output, only the error codes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
Uno dei seguenti valori: bc, html, none, plaintext, raw, wikitext
Default: bc
errorlang

Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.

Default: uselang
errorsuselocal

If given, error texts will use locally-customized messages from the MediaWiki namespace.

Tipo: booleano (dettagli)
Esempi:
Aiuto per il modulo principale.
api.php?action=help [apri in una sandbox]
Tutti gli aiuti in una pagina.
api.php?action=help&recursivesubmodules=1 [apri in una sandbox]
Permessi:
writeapi
Usa l'API in scrittura
Granted to: all, user e bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot e sysop

Tipi di dato

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

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.

expiry

Expiry values be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). For no expiry, use infinite, indefinite, infinity or never.

timestamp

Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.

Parametri template

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Crediti

API developers:

  • Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)
  • Roan Kattouw (lead developer Sep 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (lead developer 2013–present)

Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://phabricator.wikimedia.org/.