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â
- Referénsaː MediaWiki
- Licénsaː GPL-2.0-or-later
- Doocomentaçión (in ingléize)
- Etiquette & lìnie goìdda in sce l'utilìzzo
- FAQ (in ingléize)
- Mailing list
- Anónçi in sce l'API
- Bug & domànde
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).
Test: pe provâ façilménte e domànde API, védde Special:ApiSandbox.
- action
Açión da conpî.
- 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.
- block
- Blòcca 'n uténte.
- 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.
- clearhasmsg
- Scancélla o flag
hasmsgpe 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.
- delete
- Scancélla 'na pàgina.
- edit
- Crêa e modìfica pàgine.
- 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.
- 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.
- help
- Móstra a goìdda pe-i mòdoli specificæ.
- imagerotate
- Rêua unn-a ò ciù inmàgine.
- import
- Inpòrta 'na pàgina da 'n'âtra wiki, òpû da 'n file XML.
- 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.
- 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).
- setnotificationtimestamp
- Agiornâ o timestamp de notìfica pe-e pàgine òservæ.
- setpagelanguage
- Cangiâ a léngoa de 'n pàgina.
- tag
- Azónze ò levâ etichétte de modìfica da séncie verscioìn ò vôxe de regìstro.
- 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.
- 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.
- stashedit
- Intèrno. Preparâ 'na modìfica inta cache condivîza.
- Un di valoî chi de sótta: acquiretempusername, 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, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, stashedit
- Predefinito: 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
- Predefinito: 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-maxagein 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.
- Predefinito: 0
- maxage
Inpòsta l'intestaçión do contròllo da cache HTTP
max-agein 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.
- Predefinito: 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ìtoloOrigin, a rispòsta a saiâ 'n erô 403. Se sto paràmetro chi o coincìdde co-o tìtoloOrigin, e l'òrigine a l'é permìssa, i tìtoli code>Access-Control-Allow-Origin eAccess-Control-Allow-Credentialssaiàn mostræ.Pe domànde no outenticæ, specificâ o valô *. Quésto o portiâ a mostrâ o tìtolo
Access-Control-Allow-Origin, maAccess-Control-Allow-Credentialso saiâfalsee tùtti i dæti specìfichi de l'uténte saiàn limitæ.- crossorigin
Quànde s'ìntra inte l'API pe mêzo de 'na cross-domain AJAX request (CORS) e pe mêzo de 'n fornitô de sescioìn ch'o l'é segûo cóntra i atàcchi cross-site request forgery (CSRF), cómme OAuth, dêuviælo in càngio de
origin=*pe outenticâ a domànda, e dónca pe no disconétila. Quésto o gh'à da êse inclûzo inte ògni domànda de pre-flight, e dónca o gh'à da fâ pàrte de l'URI da domànda (no o còrpo POST).Tegnî prezénte che a ciù pàrte di fornitoî de sescioìn, conpréizo e sescioìn stàndard bazæ in scî cookie, no supòrtan CORS outenticæ e no pêuan êse dêuviæ con sto paràmetro chi.
- Tîpoː boleàn (detàggi)
- 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.
- Predefinito: 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
- Predefinito: 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.
- Predefinito: 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)
- 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]
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 mediawiki-api@lists.wikimedia.org ò, pe segnalâ di bug, a https://phabricator.wikimedia.org/.