Agiùtto dAPI MediaWiki

Sta chi a l'é 'na pàgina de docomentaçión de API MediaWiki outogenerâ.

Docomentaçión e ezénpiː https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Mòdolo prinçipâ

Stâto: l'API MediaWiki a l'é 'n'interfàccia méuia e stàbile ch'a l'é ativaménte suportâ e megioâ. Scibén che amiémmo de evitâlo, poriêscimo dovéi fâ de modìfiche che càozan di fonçionâ mâ; inscrîvise a-a mailing list in scî anónçi de l'API MediaWiki pe êse informòu in scî agiornaménti.

Instruçioìn eræ: quànde són dæte a-e API de instruçioìn eræ, 'n'intestaçión HTTP a saiâ mandâ co-o mesàggio "MediaWiki-API-Error" e, ségge o valô de l'intestaçión, ségge o còdice d'erô, saiàn inpòstæ co-o mæximo valô. Pe ciù informaçioìn, lêze API:Eroî e avertiménti (in ingléize).

Paràmetri specìfichi:
action

Açión da conpî.

abusefiltercheckmatch
Controlla se un filtro anti abusi viene attivato da un insieme di variabili, una modifica o un evento nel registro abusi.
abusefilterchecksyntax
Verifica la sintassi di un filtro anti abusi.
abusefilterevalexpression
Valuta un'espressione del filtro anti abusi.
abusefilterunblockautopromote
Sblocca la possibilità di autopromozione a seguito di un blocco imposto dal filtro anti abusi.
abuselogprivatedetails
Visualizza i dettagli privati di una voce del registro anti abusi.
acquiretempusername
O pìggia 'n nómme uténte tenporànio e o-o ascónde inta seçión prezénte, si-â creaçión de 'n'uténsa tenporània a l'é permìssa e l'uténte prezénte o l'é desconésso. Se 'n ómme o l'é za stæto memorizòu, o-o restitoìsce pægio.
antispoof
Controlla un nome utente con le verifiche di normalizzazione AntiSpoof.
block
Blòcca 'n uténte.
centralauthtoken
Recupera un centralauthtoken per l'esecuzione di una richiesta autenticata a un wiki collegato.
centralnoticecdncacheupdatebanner
Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
centralnoticechoicedata
Get data needed to choose a banner for a given project and language
centralnoticequerycampaign
Get all configuration settings for a campaign.
changeauthenticationdata
Modificâ i dæti d'aotenticaçión pe l'uténte corénte.
changecontentmodel
Càngia o modéllo de contegnûo de 'na pàgina
checktoken
Verìfica a validitæ de 'n token da action=query&meta=tokens.
cirrus-config-dump
Dump of CirrusSearch configuration.
cirrus-mapping-dump
Dump of CirrusSearch mapping for this wiki.
cirrus-profiles-dump
Copia dei profili di CirrusSearch per questo wiki.
cirrus-settings-dump
Dump of CirrusSearch settings for this wiki.
clearhasmsg
Scancélla o flag hasmsg pe l'uténte corénte.
clientlogin
Ìntra inta wiki dêuviàndo o flùsso interatîvo.
compare
Trêuva e diferénse tra dôe pàgine.
createaccount
Crêa 'na nêuva uténsa.
createlocalaccount
Forza la creazione di un'utenza locale. L'utenza centrale deve esistere.
cxdelete
Delete a draft translation created using the Content Translation extension.
cxsuggestionlist
Gestisce gli elenchi dei suggerimenti. Aggiunge e rimuove suggerimenti dalle liste.
cxtoken
Ottieni token JWT per l'autenticazione con cxserver.
delete
Scancélla 'na pàgina.
deleteglobalaccount
Delete a global user.
discussiontoolsedit
Met foeura un messagg in su la pagina de discussion.
discussiontoolsfindcomment
Trova un commento tramite il suo ID o nome.
discussiontoolsgetsubscriptions
Oten i stat di sotoscrizzion de certi argoment.
discussiontoolssubscribe
Inscrives (o desiscrives) per ricever di notifiche sora un argoment.
discussiontoolsthank
Send a public thank-you notification for a comment.
echocreateevent
Manually trigger a notification to a user
echomarkread
Contrassegna tutte le notifiche come lette per l'utente attuale.
echomarkseen
Contrassegna le notifiche come viste per l'utente attuale.
echomute
Mute or unmute notifications from certain users or pages.
edit
Crêa e modìfica pàgine.
editmassmessagelist
Cànbia lista de consegna par mesaji masivi
emailuser
Mànda 'n mesàggio de pòsta eletrònica a 'n uténte.
expandtemplates
Espàndi tùtti i template into wikitèsto.
featuredfeed
Returns a featured content feed.
feedcontributions
Restitoìsce o feed di contribûti de 'n uténte.
feedrecentchanges
Restitoìsce 'n feed di ùrtimi cangiaménti.
feedwatchlist
Restitoìsce 'n feed da lìsta di òservæ speciâli.
filerevert
Riprìstina 'n file a 'na versción ciù vêgia.
globalblock
Blocca o sblocca globalmente un utente.
globalpreferenceoverrides
Change local overrides for global preferences for the current user.
globalpreferences
Change global preferences of the current user.
globaluserrights
Add/remove a user to/from global groups.
growthmanagementorlist
Manage information in the structured mentor list (usually stored in MediaWiki:GrowthMentors.json). This module can be used by both current and future mentors (to add themselves or change their details) and administrators (for all users).
growthmentordashboardupdatedata
Schedule an extraordinary update of the mentee overview module in the mentor dashboard. You can only schedule one update per two hours for performance reasons.
growthsetmenteestatus
Set mentee's status (allows mentees to enable/disable mentorship module, or to opt-out entirely, which deletes the mentee/mentor relationship)
growthsetmentor
Imposta tutor dell'utente. Le modifiche verranno registrate pubblicamente.
growthstarmentee
Aggiungi o rimuovi un allievo dai preferiti dell'utenza attuale (salvati privatamente e non pubblicamente registrati)
help
Móstra a goìdda pe-i mòdoli specificæ.
homepagequestionstore
Ricevi domande formattate inviate tramite il modulo della pagina iniziale
imagerotate
Quésto mòdolo o l'é stæto dezabilitòu.
import
Inpòrta 'na pàgina da 'n'âtra wiki, òpû da 'n file XML.
jsonconfig
Allows direct access to JsonConfig subsystem.
languagesearch
Search for language names in any script.
linkaccount
Colegaménto de 'n'uténsa de 'n provider de tèrse pàrte a l'uténte corénte.
login
Ìntra e òtêgni i cookie d'aotenticaçión.
logout
Sciòrti e scancélla i dæti da sesción.
managetags
Ezegoî i cónpiti de gestión relatîvi a-i tag de modìfica.
massmessage
Send a message to a list of pages.
mergehistory
O l'unìsce e cronologîe de pàgine.
move
Méscia 'na pàgina.
opensearch
Çèrca inta wiki dêuviàndo o protocòllo OpenSearch.
options
Càngia e preferénse de l'uténte corénte.
paraminfo
Òtêgni de informaçioìn in scî mòdoli API.
parse
Stùdia o contegnûo e restitoìsce l'output do parser.
patrol
Verificâ 'na pàgina ò revixón.
protect
Modificâ o livéllo de proteçión de 'na pàgina.
purge
Netezâ a cache pe-i tìtoli indichæ.
query
Ricuperâ i dæti da e in sce MediaWiki.
removeauthenticationdata
O lêva i dæti d'aotenticaçión pe l'uténte corénte.
resetpassword
Mandâ 'n'emâi pe çèrne tórna a paròlla segrétta de 'n uténte.
revisiondelete
Scancélla ò riprìstina verscioìn.
rollback
Anulâ l'ùrtima modìfica a-a pàgina.
rsd
Esportâ 'n schêma RSD (Really Simple Discovery).
setglobalaccountstatus
Hide or lock (or unhide or unlock) a global user account.
setnotificationtimestamp
Agiornâ o timestamp de notìfica pe-e pàgine òservæ.
setpagelanguage
Cangiâ a léngoa de 'n pàgina.
shortenurl
Abbrevia un URL lungo in uno più corto.
sitematrix
Get Wikimedia sites list.
spamblacklist
Validate one or more URLs against the spam block list.
streamconfigs
Exposes event stream config. Returns only format=json with formatversion=2.
strikevote
Allows admins to strike or unstrike a vote.
sxdelete
Delete the draft section translation and its parallel corpora from database.
tag
Azónze ò levâ etichétte de modìfica da séncie verscioìn ò vôxe de regìstro.
templatedata
Fetch data stored by the TemplateData extension.
thank
Send a thank-you notification to an editor.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
torblock
Check if an IP address is blocked as a Tor exit node.
transcodereset
Users with the 'transcode-reset' right can reset and re-run a transcode job.
unblock
Sblòcca 'n uténte.
undelete
Ripristinâ verscioìn de 'na pàgina scancelâ.
unlinkaccount
O lêva 'n'uténsa de tèrse pàrte conligâ a l'uténte corénte.
upload
Caregâ 'n file ò òtegnî o stâto di caregaménti in córso.
userrights
Cangiâ l'apartenénsa a 'n grùppo uténte.
validatepassword
Convalidâ 'na paròlla segrétta anàndo aprêuvo a-e polìtiche da wiki in scê paròlle segrétte.
watch
Levâ ò azónze de pàgine da-a lìsta di òservæ speciâli de l'uténte corénte.
webapp-manifest
Returns a webapp manifest.
webauthn
API Module to communicate between server and client during registration/authentication process.
bouncehandler
Intèrno. Receive a bounce email and process it to handle the failing recipient.
categorytree
Intèrno. Modulo interno per l'estensione CategoryTree.
cirrus-check-sanity
Intèrno. Reports on the correctness of a range of page ids in the search index
collection
Intèrno. Sotmodulo per fà diverse operazzion in su ona racolta d'on utent wiki.
cspreport
Intèrno. Dêuviòu da-o motô de riçèrca pe segnalâ de violaçioìn da polìtica de seguéssa di contegnûi. Sto mòdolo chi o no va mâi dêuviòu, a eceçión di câxi inti quæ o ségge dêuviòu outomaticaménte da 'n motô de riçèrca confórme a CSP.
cxcheckunreviewed
Intèrno. Controlla se di recente è stata pubblicata qualche traduzione veloce e non revisionata per l'utente attuale.
cxpublish
Intèrno. Save a page created using the Content Translation extension.
cxpublishsection
Intèrno. Save a section created using the Content Translation extension's section translation feature.
cxsave
Intèrno. This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
cxsplit
Intèrno. Create and save a section translation to database, for every translated section of the given article translation
discussiontoolscompare
Intèrno. Oten di informazzion sora i cambiament ai coment in fra du revision de la pagina.
discussiontoolspageinfo
Intèrno. El dà indree a i metadati che gh'è besogn per dagh l'inviada ai instrument de discussion.
discussiontoolspreview
Intèrno. Preview a message on a discussion page.
echopushsubscriptions
Intèrno. Manage push subscriptions for the current user.
editcheckreferenceurl
Intèrno. Check the status of a URL for use as a reference.
fancycaptchareload
Intèrno. Ottieni un nuovo FancyCaptcha.
growthinvalidateimagerecommendation
Intèrno. Invalidate an image recommendation.
growthinvalidatepersonalizedpraisesuggestion
Intèrno. Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
helppanelquestionposter
Intèrno. Gestisci domande inviate tramite il pannello introduttivo dall'attuale utente.
jsondata
Intèrno. Retrieve localized JSON data.
oathvalidate
Intèrno. Validate a two-factor authentication (OATH) token.
parser-migration
Intèrno. Analizza una pagina con due diverse configurazioni di parser.
readinglists
Intèrno. Reading list write operations.
sanitize-mapdata
Intèrno. O fà a validaçión di dæti pe l'estensción Kartographer
scribunto-console
Intèrno. Internal module for servicing XHR requests from the Scribunto console.
securepollauth
Intèrno. Allows a remote wiki to authenticate users before granting access to vote in the election.
stashedit
Intèrno. Preparâ 'na modìfica inta cache condivîza.
sxsave
Intèrno. Save the draft section translation and store the parallel corpora
timedtext
Intèrno. Provides timed text content for usage by <track> elements
ulslocalization
Intèrno. Get the localization of ULS in the given language.
ulssetlang
Intèrno. Update user's preferred interface language.
visualeditor
Intèrno. Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Intèrno. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
wikimediaeventsblockededit
Intèrno. Log information about blocked edit attempts
Un di valoî chi de sótta: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, abuselogprivatedetails, acquiretempusername, antispoof, block, centralauthtoken, centralnoticecdncacheupdatebanner, centralnoticechoicedata, centralnoticequerycampaign, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, createlocalaccount, cxdelete, cxsuggestionlist, cxtoken, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, growthmanagementorlist, growthmentordashboardupdatedata, growthsetmenteestatus, growthsetmentor, growthstarmentee, help, homepagequestionstore, imagerotate, import, jsonconfig, languagesearch, linkaccount, login, logout, managetags, massmessage, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setglobalaccountstatus, setnotificationtimestamp, setpagelanguage, shortenurl, sitematrix, spamblacklist, streamconfigs, strikevote, sxdelete, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, cxcheckunreviewed, cxpublish, cxpublishsection, cxsave, cxsplit, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, echopushsubscriptions, editcheckreferenceurl, fancycaptchareload, growthinvalidateimagerecommendation, growthinvalidatepersonalizedpraisesuggestion, helppanelquestionposter, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, sxsave, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
Default: help
format

Formâto de l'output.

json
Dæti de output into formâto JSON.
jsonfm
Dæti de output into formâto JSON (bén formatòu in HTML).
none
Nisciùn output.
php
Dæti de output into formâto in série PHP.
phpfm
Dæti de output into formâto in série PHP (bén formatòu in HTML).
rawfm
Dæti de output, inclûxi i eleménti de debug, into formâto JSON (bén formatòu in HTML).
xml
Dæti de output into formâto XML.
xmlfm
Dæti de output into formâto XML (bén formatòu in HTML).
Un di valoî chi de sótta: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Default: jsonfm
maxlag

O màscimo ritàrdo o pêu êse dêuviòu quànde MediaWiki o l'é instalòu in sce 'n database replicated cluster. Pe sarvâ e açioìn che càozan ciù ritàrdo inta réplica do scîto, quésto paràmetro o pêu fâ de mòddo che o client o l'aspêta scìnn-a quànde o ritàrdo da réplica o ségge inferiô a-o valô specificòu. In câxo de ritàrdo ecescîvo, o còdice d'erô maxlag o l'é restitoîo co-in mesàggio cómme Waiting for $host: $lag seconds lagged.
Védde Manual: Maxlag parameter pe ciù informaçioìn.

Type: integer
smaxage

Inpòsta l'intestaçión do contròllo da cache HTTP s-maxage in sce sto nùmero de segóndi chi. I eroî no són memorizæ inta cache.

Type: integer
The value must be no less than 0.
Default: 0
maxage

Inpòsta l'intestaçión do contròllo da cache HTTP max-age in sce sto nùmero de segóndi chi. I eroî no són memorizæ inta cache.

Type: integer
The value must be no less than 0.
Default: 0
assert

Verìfica che l'uténte o l'àgge efetoòu l'intrâ (inclûzo se cómme uténte tenporànio) se s'é inpostòu user, no l'àgge efetoòu l'intrâ se s'é inpostòu anon ò ch'o l'àgge i permìsci de bot se s'é inpostòu bot.

Un di valoî chi de sótta: anon, bot, user
assertuser

Verìfica che l'uténte corénte o ségge l'uténte dezignòu.

Tipo: utent, per mezz de quaivoeuna di nom de l'utent e Uténte tenporànio
requestid

Tùtti i valoî fornîi saiàn inclûzi inta rispòsta. Poriéivan êse dêuviæ pe distìngoe e domànde.

servedby

Inclùddi into rizultâto o nómme de l'host ch'o l'à servîo a domànda.

Tîpoː boleàn (detàggi)
curtimestamp

Inclùddi into rizultâto o timestamp atoâle.

Tîpoː boleàn (detàggi)
responselanginfo

Inclùddi e léngoe dêuviæ pe uselang e errorlang into rizultâto.

Tîpoː boleàn (detàggi)
origin

Quànde ti ti gh'intri inte l'API dêuviàndo 'na cross-domain AJAX request (CORS), seleçionâla a-o domìnio òriginâle. Quésto o dêve êse fæto inte ògni domànda pre-flight, e dónca o dêve êse pàrte da domànda URI (e no do córpo POST).

Pe domànde outenticæ, quésto o dêve coincìdde co-ina de òrìgine into tìtolo Origin, dónca o dêve inpostòu ciù ò mêno cómme https://en.wikipedia.org ò https://meta.wikimedia.org. Se sto paràmetro chi o no coincìdde co-o tìtolo Origin, a rispòsta a saiâ 'n erô 403. Se sto paràmetro chi o coincìdde co-o tìtolo Origin, e l'òrigine a l'é permìssa, i tìtoli code>Access-Control-Allow-Origin e Access-Control-Allow-Credentials saiàn mostræ.

Pe domànde no outenticæ, specificâ o valô *. Quésto o portiâ a mostrâ o tìtolo Access-Control-Allow-Origin, ma Access-Control-Allow-Credentials o saiâ false e tùtti i dæti specìfichi de l'uténte saiàn limitæ.

uselang

Léngoa da dêuviâ inta traduçión di mesàggi. action=query&meta=siteinfo&siprop=languages con siprop=languages o restitoìsce 'na lìsta de còdichi de léngoe. Ti peu specificâ user pe dêuviâ e preferénse lengoìstiche prezénti de l'uténte ò content pe dêuviâ a léngoa di contegnûi de sta wiki chi.

Default: user
variant

Variànte da léngoa. O fonçiónn-a sôlo se a léngoa de bâze a supòrta a conversción de vàriante.

errorformat

Formâto da dêuviâ pe-i tèsti de avîso ò de erô

plaintext
Wikitèsto con tag HTML levæ e entitæ sostitoîe.
wikitext
Wikitèsto no analizòu.
html
HTML
raw
Ciâve di mesàggi e paràmetri.
none
Nisciùn tèsto in sciortîa, sôlo còdichi d'erô.
bc
Formâto dêuviòu prìmma de MediaWiki 1.29. errorlang e errorsuselocal són ignoræ.
Un di valoî chi de sótta: bc, html, none, plaintext, raw, wikitext
Default: bc
errorlang

Léngoa da dêuviâ pe mesàggi d'avîso e d'erô. action=query&meta=siteinfo&siprop=languages con siprop=languages o restitoìsce 'na lìsta de còdichi de léngoe. Ti peu specificâ content pe dêuviâ a léngoa di contegnûi de sta wiki chi ò uselang pe dêuviâ o mæximo valô do paràmetro uselang.

Default: uselang
errorsuselocal

Se inpostòu, o tèsto d'erô de sòlito o mostriâ di mesàggi inpostæ localménte into namespace MediaWiki.

Tîpoː boleàn (detàggi)
centralauthtoken

When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use action=centralauthtoken on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).

Ezénpi:
Agiùtto pe-o mòdolo prinçipâ.
api.php?action=help [arvî inte 'na sandbox]
Tùtti i agiùtti inte 'na pàgina.
api.php?action=help&recursivesubmodules=1 [arvî inte 'na sandbox]
Permiscioìn:
writeapi
Dopra i API in scrittura
Concèsso a: all, user e bot
apihighlimits
Dêuviâ lìmiti inte query API ciù âti (query lénteː 500, query spedîeː 5000). I lìmiti pe-e query lénte se àplican a-i paràmetri multivalô ascì.
Concèsso a: bot e sysop

Tîpi de dæto

L'input a MediaWiki o dêv'êse UTF-8 normalizòu NFC. MediaWiki o peu tentâ de convertî âtri input, ma quésto o poriéiva caxonâ o faliménto de çèrte òperaçioìn (c̟ómme modìfica con contròlli MD5).


I paràmetri che pîgian ciù valoî són de sòlito inviæ co-i valoî separæ do caràtere pipe, prezénpio param=value1|value2 ò param=value1%7Cvalue2. Se 'n valô o dêve contegnî 'n caràtere pipe, dêuviâ U+001F (Unit Separator) cómme separatô e prefìsso do valô U+001F, prezénpio param=%1Fvalue1%1Fvalue2.

Dötréi tîpi de paràmetri inte domànde API àn bezéugno de spiegaçioìn de ciùː

boolean

'N paràmetro boleàn o fonçiónn-a cómme e cazélle de contròllo HTMLː se o paràmetro o l'é specificòu, indipendenteménte da-o valô, o l'é conscideròu vêo. Pe 'n valô fâso, òmétte do tùtto o paràmetro.

expiry

I valoî de scadénsa poriéivan êse relatîvi (prezénpio 5 months ò 2 weeks) ò asolûti (prezénpio 2014-09-18T12:34:56Z). Pe nisciùnn-a scadénsa, dêuviâ infinite, indefinite, infinity ò never.

timestamp

I timestamp pêuan êse scrîti inte vàrri formâti, védde a libràia di formâti de input di timestamp docomentâ in sce mediawiki.org pe-i detàggi. L'é consegiòu dæta e ténpo ISO 8601: 2001-01-15T14:56:00Z. Pe de ciù, a strìnca now a peu êse dêuviâ pe specificâ o timestamp corénte.

Paràmetri template

I paràmetri template supòrtan câxi inti quæ 'n mòdolo API o domànda 'n valô pe ògni valô de âtri paràmetri. Prezénpio, se ghe foîse 'n mòdolo API ch'o domànda frûto, o doviéiva avéi 'n paràmetro fruits pe specificâ quæ frûti són domandæ e 'n paràmetro template {fruit}-quantity pe specificâ quànti domandâ pe ògni frûto. 'N client API ch'o veu 1 méia, 5 banànn-e e 20 merélli o peu dónca fà 'na domànda cómme fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Créditi

Svilupatoî de API

  • Yuri Astrakhan (creatô, svilupatô càppo Set 2006–Set 2007)
  • Roan Kattouw (svilupatô càppo Set 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (svilupatô càppo 2013–2020)

Pe piâxéi mànda i tò coménti, drîte e domànde a l'indirìsso [email protected] ò, pe segnalâ di bug, a https://phabricator.wikimedia.org/.