MediaWiki-API-hjelp
Dette er en automatisk generert MediaWiki-API-dokumentasjonsside.
Dokumentasjon og eksempler: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Hovedmodul
- Kilde: MediaWiki
- Lisens: GPL-2.0-or-later
Status: Alle funksjonene som vises på denne siden skal virke, men API-et er fortsatt i aktiv utvikling, og kan bli endret når som helst. Abonner på MediaWiki sin API-kunnkjøringsepostliste for nyheter om oppdateringer.
Feile kall: Hvis det blir sendt gale kall til API-et, blir det sendt en HTTP-header med nøkkelen "MediaWiki-API-Error" og da blir både header-verdien og feilkoden sendt tilbake med samme verdi. For mer informasjon, se API: Feil og advarsler.
Testing: For enkelt å teste API-kall, se Special:ApiSandbox.
- action
Hvilken handling skal utføres
- block
- Blokker en bruker.
- changeauthenticationdata
- Endre autentiseringsdata for den nåværende brukeren.
- changecontentmodel
- Endre innholdsmodellen til en side
- checktoken
- Sjekk gyldigheten til et tegn fra action=query&meta=tokens.
- clearhasmsg
- Fjerner
hasmsg
-flagget for den aktuelle brukeren. - clientlogin
- Logg inn på wikien med den interaktive flyten.
- compare
- Hent forskjellen mellom to sider.
- createaccount
- Opprett en ny brukerkonto.
- delete
- Slett en side.
- edit
- Opprett og rediger sider.
- emailuser
- Send e-post til en bruker.
- expandtemplates
- Ekspanderer alle maler i wikitekst.
- feedcontributions
- Returnerer en mating med brukerbidrag.
- feedrecentchanges
- Returnerer en mating med siste endringer.
- feedwatchlist
- Returnerer en overvåkningslistemating.
- filerevert
- Tilbakestill en fil til en gammel versjon.
- help
- Vis hjelp for de gitte modulene.
- imagerotate
- Roter ett eller flere bilder.
- import
- Importer en side fra en annen wiki eller fra en XML-fil.
- linkaccount
- Lenk en konto fra en tredjepartsleverandør til den gjeldende brukeren.
- login
- Logg inn og få autentiseringsinformasjonskapsler.
- logout
- Logg ut og fjern sesjonsdata.
- managetags
- Utfører håndteringsoppgaver i forbindelse med endringstagger.
- mergehistory
- Flett sidehistorikker.
- move
- Flytt en side.
- opensearch
- Søk i wikien med OpenSearch-protokollen.
- options
- Endre innstillingene til den gjeldende brukeren.
- paraminfo
- Hent informasjon om API-moduler.
- parse
- Tolk innhold og returner parserresultatet.
- patrol
- Patruljer en side eller sideversjon.
- pfautocomplete
- Autofullføring brukt av Page Forms-utvidelsen.
- pfautoedit
- Opprett eller rediger en side med skjema definert av utvidelsen Page Forms.
- protect
- Endre beskyttelsesnivået til en side.
- purge
- Gjenoppfrisk mellomlageret for de gitte titlene.
- query
- Hent data fra og om MediaWiki.
- removeauthenticationdata
- Fjern autentiseringsdata for den gjeldende brukeren.
- resetpassword
- Send en bruker en e-post for nullstilling av passord.
- revisiondelete
- Slett og gjenopprett sideversjoner.
- rollback
- Omgjør den siste redigeringen på siden.
- rsd
- Eksporter et RSD-skjema (Really Simple Discovery).
- setnotificationtimestamp
- Oppdater varselstidsstempelet for overvåkede sider.
- setpagelanguage
- Endre språket til en side.
- tag
- Legg til eller fjern endringstagger fra individuelle sideversjoner eller loggoppføringer.
- unblock
- Avblokker en bruker.
- undelete
- Gjenopprett sideversjonene til en slettet side.
- unlinkaccount
- Fjern en lenket tredjepartskonto fra den gjeldende brukeren.
- upload
- Last opp en fil, eller hent statusen til vendende opplastinger.
- userrights
- Endre en brukers gruppemedlemskap.
- validatepassword
- Valider et passord mot wikiens passordkrav.
- watch
- Legg til eller fjern sider fra den gjeldende brukerens overvåkningsliste.
- cspreport
- Intern. Brukes av nettlesere for å rapportere brudd på Content Security Policy. Denne modulen bør aldri brukes utenom av en CSP-mottakelig nettleser.
- oathvalidate
- Intern. Valider en nøkkel for tofaktorautentisering (OATH).
- stashedit
- Intern. Forbered en redigering i delt mellomlager.
- visualeditor
- Intern. Returnerer HTML5 for en side fra Parsoid-tjenesten.
- visualeditoredit
- Intern. Lagre en HTML5-side til MediaWiki (konvertert til wikitekst med Parsoid-tjenesten).
- Én av følgende verdier: 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, pfautocomplete, pfautoedit, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, oathvalidate, stashedit, visualeditor, visualeditoredit
- Standard: help
- format
Resultatets format.
- json
- Resultatdata i JSON-format.
- jsonfm
- Gi utdata i JSON-format (pretty-print i HTML).
- none
- Ingen resultat.
- php
- Utdata i serialisert PHP-format.
- phpfm
- Gi utdata i serialisert PHP-format (pretty-print i HTML).
- rawfm
- Gi utdata, inkludert feilsøkingselementer, i JSON-format (pretty-print i HTML).
- xml
- Gi utdata i XML-format.
- xmlfm
- Gi utdata i XML-format (pretty-print i HTML).
- Én av følgende verdier: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
- Standard: jsonfm
- maxlag
Maksimal forsinkelse kan brukes når MediaWiki er installert på et database-replikert cluster. For å unngå operasjoner som forårsaker replikasjonsforsinkelser, kan denne parameteren få klienten til å vente til replikasjonsforinkelsen er mindre enn angitt verdi. I tilfelle ytterliggående forsinkelser, blir feilkoden maxlag returnert med en melding som Venter på $host: $lag sekunders forsinkelse.
Se Manual: Maxlag parameter for mer informasjon.- Type: heltall
- smaxage
Sett
s-maxage
HTTP cache control header til dette antall sekunder. Feil blir aldri mellomlagret.- Type: heltall
- Standard: 0
- maxage
Set
max-age
HTTP cache control header til dette antall sekunder. Feil blir aldri mellomlagret.- Type: heltall
- Standard: 0
- assert
Verifiser at brukeren er logget inn om satt til user, ikke er logget inn hvis den satt til anon, eller har botrettighet om satt til bot.
- Én av følgende verdier: anon, bot, user
- assertuser
Verifiser at den gjeldende brukeren er den navngitte brukeren.
- Type: bruker, av brukernavn
- requestid
En gitt verdi her vil inkluderes i responsen. Kan brukes til å skille forespørsler fra hverandre.
- servedby
Inkluder navnet på tjeneren som utførte forespørselen i resultatene.
- Type: boolsk (detaljer)
- curtimestamp
Inkluder det nåværende tidsmerket i resultatet.
- Type: boolsk (detaljer)
- responselanginfo
Inkluder språkene brukt for uselang og errorlang i resultatet.
- Type: boolsk (detaljer)
- origin
Når man aksesserer API-en som bruker en domene-kryssende AJAX-forespørsel (CORS), sett denne til det opprinnelige domenet. Denne må tas med i alle pre-flight-forespørsler, og derfor være en del av spørre-URI-en (ikke POST-kroppen).
For autentiserte forespørsler må denne stemme helt med en av de opprinnelige i
Origin
-headeren, slik at den må settes til noe a la https://en.wikipedia.org eller https://meta.wikimedia.org. Hvis denne parameteren ikke stemmer medOrigin
-headeren, returneres et 403-svar. Hvis denne parameteren stemmer medOrigin
-headeren og originalen er hvitlistet, vilAccess-Control-Allow-Origin
ogAccess-Control-Allow-Credentials
-headere bli satt.For ikke-autentiserte forepørsler, spesifiser *. Denne vil gjøre at
Access-Control-Allow-Origin
-headeren blir satt, menAccess-Control-Allow-Credentials
blirfalse
og alle bruerspesifikke data blir begrenset.- uselang
Språk å bruke for meldingsoversettelser. action=query&meta=siteinfo med siprop=languages returnerer en liste over språkkoder, eller spesifiser user for å bruke den nåværende brukerens språkpreferanser, eller spesifiser content for å bruke denne wikiens innholdsspråk.
- Standard: user
- variant
Språkvarianten. Virker bare dersom grunnspråket støtter variantkonvertering.
- errorformat
Formater som kan brukes for advarsels- og feiltekster
- plaintext
- Wikitext hvor HTML-tagger er fjernet og elementer er erstattet.
- wikitext
- Ubehandlet wikitext.
- html
- HTML
- raw
- Meldingsnøkler og -parametre.
- none
- Ingen tekst, bare feilkoder.
- bc
- Format brukt før MediaWiki 1.29. errorlang og errorsuselocal ignoreres.
- Én av følgende verdier: bc, html, none, plaintext, raw, wikitext
- Standard: bc
- errorlang
Språk som skal brukes for advarsler og feil. action=query&meta=siteinfo med siprop=languages returnerer ei liste over språkkoder, eller angi content for å bruke wikiens innholdsspråk, eller angi uselang for å bruke samme verdi som uselang-parameteren.
- Standard: uselang
- errorsuselocal
Hvis gitt, vil feiltekster bruke lokalt tilpassede meldinger fra MediaWiki-navnerommet.
- Type: boolsk (detaljer)
- Hjelp for hovedmodulen.
- api.php?action=help [åpne i sandkasse]
- All hjelp på en side.
- api.php?action=help&recursivesubmodules=1 [åpne i sandkasse]
Datatyper
Innputt til MediaWiki bør være NFC-normalisert UTF-8. MediaWiki kan prøve å konvertere annen innputt, men dette kan gjøre at noen handlinger (som redigeringer med MD5-sjekker) feiler.
Parametere som tar flere verdier sendes normalt inn med verdiene atskilt av vertikalstrek, f.eks. param=value1|value2 eller param=value1%7Cvalue2. Hvis en verdi må inneholde vertikalstreken, bruk U+001F (Unit Separator) som skilletegn og bruk U+001F foran verdien, f.eks. param=%1Fvalue1%1Fvalue2.
Noen parametertyper i API-forespørsler trenger videre forklaring:
- boolean
Boolske parametere fungerer som sjekkbokser i HTML: hvis parameteren er angitt, uansett verdi, anses den som sann. For en falsk verdi, unngå parameteren i sin helhet.
- expiry
Utløpsverdier kan være relative (f.eks. 5 months eller 2 weeks) eller absolutte (f.eks. 2014-09-18T12:23:56Z). For ingen utløpsdato, bruk infinite, indefinite, infinity eller never.
- timestamp
Tidsstempler kan angis i flere formater, se dokumentasjonen på MediaWiki.org for detaljer. ISO 8601 for dato og tid anbefales: 2001-01-15T14:56:00Z. Strengen now kan også brukes for å angi nåtid.
«Templated» parametre
«Templated» parametre støtter tilfeller der en API-modul trenger en verdi for hver verdi av en annen parameter. Hvis det for eksempel var en API-modul for å be om frukt, ville den kunne ha en parameter fruits for å angi hvilken frukt det bes om og en «templated» parameter {fruit}-quanity for å angi hvor mange av hver frukt det bes om. En API-klient som vil ha ett eple, fem bananer og 20 jordbær kan dermed gjøre forespørsler som fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.
Kreditering
API-utviklere:
- Yuri Astrakhan (skaper, hovedutvikler sept. 2006–sept. 2007)
- Roan Kattouw (hovedutvikler sept. 2007–2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsh (hovedutvikler 2013–2020)
Send kommentarer, forslag og spørsmål til mediawiki-api@lists.wikimedia.org eller post en feilrapport på https://phabricator.wikimedia.org/.