MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: 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.

Testing: For enkelt å teste API-kall, se Special:ApiSandbox.

Parametre:
action

Hvilken handling skal utføres

abusefiltercheckmatch
Sjekk om et misbruksfilter matcher et sett variabler (editorlogget misbruksfilterhendelse).
abusefilterchecksyntax
Sjekk syntaksen til et misbruksfilter.
abusefilterevalexpression
Evaluerer et uttrykk i et misbruksfilter.
abusefilterunblockautopromote
Fjerner en brukers blokkering fra å få automatiske forfremmelser basert på konsekvenser av misbruksfiltre.
block
Blokker en bruker.
categorytree
Intern modul for CategoryTree-utvidelsen.
changeauthenticationdata
Endre autentiseringsdata for den nåværende brukeren.
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.
cspreport
Brukes av nettlesere for å rapportere brudd på Content Security Policy. Denne modulen bør aldri brukes utenom av en CSP-mottakelig nettleser.
delete
Slett en side.
echomarkread
Marker varsler som lest for den gjeldende brukeren.
echomarkseen
Marker varsler som sett for den gjeldende brukeren.
edit
Opprett og rediger sider.
editmassmessagelist
Rediger en leveringsliste for massemeldinger.
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
Perform management tasks relating to change tags.
massmessage
Send en melding til en liste over sider.
mergehistory
Flett sidehistorikker.
mobileview
Returnerer data som trengs for mobilvisning.
move
Flytt en side.
multiupload-unpack
Unpack a ZIP or tar file before importing its contents.
oathvalidate
Valider et tofaktorautentiseringstegn (OATH).
opensearch
Search the wiki using the OpenSearch protocol.
options
Change preferences of the current user.
paraminfo
Hent informasjon om API-moduler.
parse
Parses content and returns parser output.
patrol
Patruljer en side eller revisjon.
protect
Change the protection level of a page.
purge
Purge the cache for the given titles.
query
Fetch data from and about 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
Export an RSD (Really Simple Discovery) schema.
scribunto-console
Intern modul for å betjene XHR-forespørsler fra Scribunto-konsollen.
setnotificationtimestamp
Oppdater varselstidsstempelet for overvåkede sider.
setpagelanguage
Endre språket til en side.
spamblacklist
Valider én eller flere URL-er mot SpamBlacklist.
stashedit
Prepare an edit in shared cache.
tag
Legg til eller fjern endringstagger fra individuelle revisjoner eller loggoppføringer.
thank
Send et takkevarsel til en bidragsyter.
titleblacklist
Valider en sidetittel, et filnavn eller et brukernavn mot TitleBlacklist.
transcodereset
Brukere med rettigheten «transcode-reset» kan nullstille og kjøre omkodingsjobber på nytt.
unblock
Avblokker en bruker.
undelete
Restore revisions of a deleted page.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
Change a user's group membership.
validatepassword
Valider et passord mot wikiens passordkrav.
watch
Add or remove pages from the current user's watchlist.
webapp-manifest
Returnerer et webapp-manifest.
tokens
Utgått. Get tokens for data-modifying actions.
Én av følgende verdier: abusefiltercheckmatch, abusefilterchecksyntax, abusefilterevalexpression, abusefilterunblockautopromote, block, categorytree, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, echomarkread, echomarkseen, edit, editmassmessagelist, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, massmessage, mergehistory, mobileview, move, multiupload-unpack, oathvalidate, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, scribunto-console, setnotificationtimestamp, setpagelanguage, spamblacklist, stashedit, tag, thank, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, tokens
Standard: help
format

Resultatets format.

json
Resultatdata i JSON-format.
jsonfm
Output data in JSON format (pretty-print in HTML).
none
Ingen resultat.
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).
É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, eller har botrettighet om satt til bot.

Én av følgende verdier: user, bot
assertuser

Verifiser at den gjeldende brukeren er den navngitte brukeren.

Type: 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 verdi (detaljer)
curtimestamp

Inkluder det nåværende tidsmerket i resultatet.

Type: boolsk verdi (detaljer)
responselanginfo

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

Type: boolsk verdi (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 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.

Standard: 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: plaintext, wikitext, html, raw, none, bc
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 verdi (detaljer)
Tillatelser:
writeapi
Redigere via API
Gitt til: all, userog bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Gitt til: botog 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.

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.
timestamp
Timestamps may be specified in several formats. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now
alternative multiple-value separator
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.

Credits

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 [email protected] or file a bug report at https://phabricator.wikimedia.org/.