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
- 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.
- abuselogprivatedetails
- Vis private detaljer i en misbruksloggoppføring.
- acquiretempusername
- Innhent et midlertidig brukernavn og lagre det i den aktive økten, hvis opprettelse av midlertidige kontoer er aktivert og den aktive brukeren er logget ut. Hvis et navn allerede har blitt lagret, returner samme navn.
- antispoof
- Sjekk et brukernavn mot AntiSpoofs normaliseringssjekker.
- block
- Blokker en bruker.
- centralauthtoken
- Hent et centralauthtoken for å utføre en autentisert forespørsel til en tilkoblet wiki.
- centralnoticecdncacheupdatebanner
- Be om at bannerinnholdet som mellomlagres i CDN (frontend) for anonyme brukere skal oppdateres, for det forespurte banneret og språket
- centralnoticechoicedata
- Hent data som trengs for å velge banner for et gitt prosjekt og språk
- centralnoticequerycampaign
- Hent konfigurasjonsinnstillinger for en kampanje.
- 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.
- cirrus-config-dump
- Dump av CirrusSearch-konfigurasjon.
- cirrus-mapping-dump
- Dump av CirrusSearch-mapping for denne wikien.
- cirrus-profiles-dump
- Dump av CirrusSearch-profiler for denne wikien.
- cirrus-settings-dump
- Dump av CirrusSearch-innstillinger for denne wikien.
- clearhasmsg
- Fjerner
hasmsg
-flagget for den aktuelle brukeren. - clientlogin
- Logg inn på wikien med den interaktive flyten.
- communityconfigurationedit
- Change the content of a configuration provider in Community configuration
- compare
- Hent forskjellen mellom to sider.
- createaccount
- Opprett en ny brukerkonto.
- createlocalaccount
- Tving opprettelse av lokal konto. Den sentrale kontoen må eksistere.
- cxdelete
- Slett en oversettelseskladd som bruker innholdsoversettelsesutvidelsen.
- cxsuggestionlist
- Behandle forslagslistene. Legg til og fjern forslag.
- cxtoken
- Hent JWT-tegn for å autentisere mot cxserver.
- delete
- Slett en side.
- deleteglobalaccount
- Slett en global bruker.
- discussiontoolsedit
- Post en beskjed på en diskusjonsside.
- discussiontoolsfindcomment
- Finn en kommentar etter ID eller navn.
- discussiontoolsgetsubscriptions
- Få abonnementenes status på angitte emner.
- discussiontoolssubscribe
- Abonner (eller avslutt abonnement) for å motta varsler om et emne.
- discussiontoolsthank
- Send et offentlig takkevarsel for en kommentar.
- echocreateevent
- Utløs et varsel til en bruker manuelt
- echomarkread
- Marker varsler som lest for den gjeldende brukeren.
- echomarkseen
- Marker varsler som sett for den gjeldende brukeren.
- echomute
- Slå av eller på varsler fra visse brukere eller sider.
- edit
- Opprett og rediger sider.
- editmassmessagelist
- Rediger en leveringsliste for massemeldinger.
- emailuser
- Send e-post til en bruker.
- expandtemplates
- Ekspanderer alle maler i wikitekst.
- featuredfeed
- Returnerer en mating med utmerket innhold.
- 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.
- flow
- Lar handlinger bli tatt på strukturerte diskusjonssider.
- flow-parsoid-utils
- Konverter tekst mellom wikitekst og HTML.
- flowthank
- Send en offentlig takk for en Flow-kommentar.
- globalblock
- Blokker eller avblokker en bruker globalt.
- globalpreferenceoverrides
- Endre lokal overstyring av globale innstillinger for den gjeldende brukeren.
- globalpreferences
- Endre de globale innstillingene til den gjeldende brukeren.
- globaluserrights
- Legg til/fjern en bruker til/fra globale grupper.
- growthmanagementorlist
- Behandle informasjon i den strukturerte fadderlisten (vanligvis lagret i MediaWiki:GrowthMentors.json). Denne modulen kan brukes både av nåværende og framtidige faddere (for å legge seg til eller endre detaljene sine) og administratorer (for alle brukere).
- growthmentordashboardupdatedata
- Planlegg en ekstraordinær oppdatering av modulen for fadderbarnoversikt i kontrollpanelet for faddere. Av ytelsesgrunner må det gå minst to timer mellom hver oppdatering.
- growthsetmenteestatus
- Sett fadderbarnets status (lar fadderbarn slå av og på faddermodulen eller velge å ikke bruke den i det hele tatt, hvilket sletter forholdet mellom fadder og fadderbarn)
- growthsetmentor
- Sett brukerens fadder. Endringen blir logget offentlig.
- growthstarmentee
- Merk eller fjern stjernemerking av et fadderbarn av den gjeldende brukeren (lagres privat og logges ikke)
- help
- Vis hjelp for de gitte modulene.
- homepagequestionstore
- Hent formaterte spørsmål postet via hjemmesidemoduler
- imagerotate
- Denne modulen har blitt deaktivert
- import
- Importer en side fra en annen wiki eller fra en XML-fil.
- jsonconfig
- Muliggjør direkte tilgang til undersystemet JsonConfig.
- languagesearch
- Søk etter språknavn uansett alfabet.
- 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.
- massmessage
- Send en melding til en liste over sider.
- 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.
- 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).
- setglobalaccountstatus
- Skjul eller lås (eller vis eller lås opp) en global brukerkonto.
- setnotificationtimestamp
- Oppdater varselstidsstempelet for overvåkede sider.
- setpagelanguage
- Endre språket til en side.
- shortenurl
- Gjør en lang URL kort.
- sitematrix
- Hent liste over Wikimedia-sider.
- spamblacklist
- Valider én eller flere URL-er mot spamblokkeringslista.
- streamconfigs
- Viser konfigurasjon for hendelsesstrøm. Returnerer kun format=json med formatversion=2.
- strikevote
- Lar administratorer stryke stemmer eller fjerne stryking av stemmer.
- sxdelete
- Slett oversettelsesutkastet av seksjonen og parallellteksten fra databasen.
- tag
- Legg til eller fjern endringstagger fra individuelle sideversjoner eller loggoppføringer.
- templatedata
- Hent data lagret av utvidelsen TemplateData.
- thank
- Send et takkevarsel til en bidragsyter.
- titleblacklist
- Valider en sidetittel, et filnavn eller et brukernavn mot TitleBlacklist.
- torblock
- Sjekk om en IP-adresse er blokkert som Tor-utgangsnode.
- transcodereset
- Brukere med rettigheten «transcode-reset» kan nullstille og kjøre omkodingsjobber på nytt.
- 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.
- webapp-manifest
- Returnerer et webapp-manifest.
- webauthn
- API-modul for å kommunisere mellom tjeneren og klienten under registrerings-/autentiseringsprosessen.
- wikilove
- Gi wikiskryt til en annen bruker.
- bouncehandler
- Intern. Motta en returepost og prosesser den for å behandle den feilende mottakeren.
- categorytree
- Intern. Intern modul for CategoryTree-utvidelsen.
- cirrus-check-sanity
- Intern. Reports on the correctness of a range of page ids in the search index
- collection
- Intern. API-modul for å utføre diverse operasjoner på en brukers samling.
- cspreport
- Intern. Brukes av nettlesere for å rapportere brudd på Content Security Policy. Denne modulen bør aldri brukes utenom av en CSP-mottakelig nettleser.
- cxcheckunreviewed
- Intern. Sjekk om brukeren nylig har publisert raske, ugjennomgåtte oversettelser.
- cxpublish
- Intern. Lagre en side opprettet med innholdsoversettelsesutvidelsen.
- cxpublishsection
- Intern. Lagre en seksjon opprettet ved bruk av innholdsoversettelsesutvidelsen seksjonsoversettelsesfunksjon.
- cxsave
- Intern. Denne modulen gjør det mulig å lagre oversettelseskladder etter seksjon for å spare båndbredde og samle inn parallelle korpus.
- cxsplit
- Intern. Opprett og lagre seksjonsoversettelser i databasen, for hver oversatte seksjon av den gitte artikkeloversettelsen
- discussiontoolscompare
- Intern. Hent informasjon om kommentarendringer mellom to sideversjoner.
- discussiontoolspageinfo
- Intern. Returnerer metadata som kreves for å initialisere diskusjonsverktøyene.
- discussiontoolspreview
- Intern. Forhåndsvis en melding på ei diskusjonsside.
- echopushsubscriptions
- Intern. Behandle push-abonnementer for den gjeldende brukeren.
- editcheckreferenceurl
- Intern. Check the status of a URL for use as a reference.
- fancycaptchareload
- Intern. Hent en ny FancyCaptcha.
- growthinvalidateimagerecommendation
- Intern. Merk bildeforslag som ugyldig
- growthinvalidatepersonalizedpraisesuggestion
- Intern. Ugyldiggjør et forslag om fadderbarn som fortjener skryt i modulen for personlig skryt i fadderpanelet
- helppanelquestionposter
- Intern. Håndtere spørsmål som er postet via hjelpepanelet for den gjeldende brukeren.
- jsondata
- Intern. Hent lokalisert JSON-data.
- oathvalidate
- Intern. Valider en nøkkel for tofaktorautentisering (OATH).
- parser-migration
- Intern. Tolk en side med to forskjellige parserkonfigurasjoner.
- readinglists
- Intern. Skriveoperasjoner for leselister.
- sanitize-mapdata
- Intern. Utfører datavalidering for Kartographer-utvidelsen
- scribunto-console
- Intern. Intern modul for å betjene XHR-forespørsler fra Scribunto-konsollen.
- securepollauth
- Intern. Gjør det mulig for en ekstern wiki å autentisere brukere før de får tilgang til å stemme i valget.
- stashedit
- Intern. Forbered en redigering i delt mellomlager.
- sxsave
- Intern. Lagre oversettelsesutkastet av seksjonen og lagre parellellteksten
- timedtext
- Intern. Gir timet tekstinnhold for bruk av <track>-elementer
- ulslocalization
- Intern. Hent lokaliseringen av ULS på det gitte språket.
- ulssetlang
- Intern. Oppdater brukerens foretrukne grensesnittspråk.
- visualeditor
- Intern. Returnerer HTML5 for en side fra Parsoid-tjenesten.
- visualeditoredit
- Intern. Lagre en HTML5-side til MediaWiki (konvertert til wikitekst med Parsoid-tjenesten).
- wikimediaeventsblockededit
- Intern. Logg informasjon om blokkerte redigeringsforsøk
- Én av følgende verdier: 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, communityconfigurationedit, 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, flow-parsoid-utils, flow, flowthank, 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, wikilove, 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
- 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
- Verdien må være mindre enn 0.
- Standard: 0
- maxage
Set
max-age
HTTP cache control header til dette antall sekunder. Feil blir aldri mellomlagret.- Type: heltall
- Verdien må være mindre enn 0.
- Standard: 0
- assert
Verifiser at brukeren er logget inn (muligens også som midlertidig bruker) 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 en av brukernavn og Midlertidig bruker
- 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&siprop=languages returnerer en liste over språkkoder. Du kan spesifisere user for å bruke den nåværende brukerens språkpreferanser, eller spesifisere 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&siprop=languages returnerer ei liste over språkkoder. 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)
- centralauthtoken
Når du aksesserer API-et med en kryssdomene-AJAX-forespørsel (CORS), bruk dette for å autentisere som den nåværende SUL-brukeren. Bruk action=centralauthtoken på denne wikien for å hente tegnet, før du gjennomfører CORS-forespørselen. Hvert tegn kan bare brukes én gang, og utløper etter 10 sekunder. Dette bør inkluderes i enhver forhåndsforespørsel, og bør derfor inkluderes i forespørselens URI (ikke i POST-innholdet).
- 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 [email protected] eller post en feilrapport på https://phabricator.wikimedia.org/.