MediaWiki-API-hjelp

Dette er en automatisk generert MediaWiki-API-dokumentasjonsside.

Dokumentasjon og eksempler: https://www.mediawiki.org/wiki/API

Hovedmodul

Status: Alle funksjonene som vises på denne siden skal virke, men API-en 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 feile 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.

Parametre:
action

Hvilken handling skal utføres

ask
API-modul for å kjøre spørringer mot Semantic MediaWiki med ask-språket.
askargs
API-modul for å kjøre spørringer mot Semantic MediaWiki med ask-språket som en liste over forutsetninger, printouts og parametre.
block
Blokker en bruker.
changeauthenticationdata
Endre autentiseringsdata for den nåværende brukeren.
changecontentmodel
Change the content model of a page
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.
idprovider-increment
idprovider-random
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 revisjon.
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 epost for nullstilling av passord til en bruker.
revisiondelete
Slett og gjenopprett revisjoner.
rollback
Omgjør den siste redigeringen på siden.
rsd
Eksporter et RSD-skjemae (Really Simple Discovyr).
setnotificationtimestamp
Oppdater varselstidsstempelet for overvåkede sider.
setpagelanguage
Endre språket til en side.
smwbrowse
API-modul for å støtte leseaktiviteter for forskjellige entitetstyper i Semantic MediaWiki.
smwinfo
API-modul for å hente informasjon om Semantic MediaWiki-statistikk og annen metainformasjon.
smwtask
API-modul for å utføre Semantic MediaWiki-relaterte oppgaver (kun for intern bruk, ikke offentlig bruk).
tag
Legg til eller fjern endringstagger fra individuelle revisjoner eller loggoppføringer.
unblock
Avblokker en bruker.
undelete
Gjenopprett revisjonene 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.
browsebyproperty
Utgått. API-modul for å hente informasjon om en egenskap eller en liste over egenskaper.
browsebysubject
Utgått. API-modul for å hente informasjon om et subjekt.
tokens
Utgått. Hent nøkler for handlinger som modifiserer data.
cspreport
Intern. Brukes av nettlesere for å rapportere brudd på Content Security Policy. Denne modulen bør aldri brukes utenom av en CSP-mottakelig nettleser.
scribunto-console
Intern. Intern modul for å betjene XHR-forespørsler fra Scribunto-konsollen.
stashedit
Intern. Forbered en redigering i delt mellomlager.
Én av følgende verdier: ask, askargs, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, idprovider-increment, idprovider-random, 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, smwbrowse, smwinfo, smwtask, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, browsebyproperty, browsebysubject, tokens, cspreport, scribunto-console, stashedit
Default: 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
Default: 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: integer
smaxage

Sett s-maxage HTTP cache control header til dette antall sekunder. Feil blir aldri mellomlagret.

Type: integer
Default: 0
maxage

Set max-age HTTP cache control header til dette antall sekunder. Feil blir aldri mellomlagret.

Type: integer
Default: 0
assert

Verifiser at brukeren er logget inn om satt til user, 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: boolean (details)
curtimestamp

Inkluder det nåværende tidsmerket i resultatet.

Type: boolean (details)
responselanginfo

Inkluder språkene brukt for uselang og errorlang i resultatet.

Type: boolean (details)
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 med Origin-headeren, returneres et 403-svar. Hvis denne parameteren stemmer med Origin-headeren og originalen er hvitlistet, vil Access-Control-Allow-Origin og Access-Control-Allow-Credentials-headere bli satt.

For ikke-autentiserte forepørsler, spesifiser *. Denne vil gjøre at Access-Control-Allow-Origin-headeren blir satt, men Access-Control-Allow-Credentials blir false 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.

Default: user
errorformat

Formater som kan brukes for advarsels- og feiltekster.

plaintext
Wikitext der HTML-tagger er fjernet og elementer byttet ut.
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 ses bort fra.
Én av følgende verdier: bc, html, none, plaintext, raw, wikitext
Default: 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.

Default: uselang
errorsuselocal

Hvis gitt, vil feiltekster bruke lokalt tilpassede meldinger fra MediaWiki-navnerommet.

Type: boolean (details)
Tillatelser:
writeapi
Redigere via API
Gitt til: all, user og bot
apihighlimits
Bruk høyere grenser i API-spørringer (trege spørringer: 500; raske spørringer: 5000). Grensene for trege spørringer gjelder også parametre med flere verdier.
Gitt til: bot og sysop

Datatyper

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.

«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–nå)

Send kommentarer, forslag og spørsmål til mediawiki-api@lists.wikimedia.org eller post en feilrapport på https://phabricator.wikimedia.org/.