MediaWiki API hulp

Dit is een automatisch aangemaakte documentatiepagina over de API van MediaWiki.

Documentatie en voorbeelden: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Hoofdmodule

Status: De MediaWiki-API is een stabiele interface die actief ondersteund en verbeterd wordt. Hoewel we het proberen te vermijden, moeten we af en toe toch ingrijpende wijzigingen doorvoeren. Abonneer u op de e-maillijst mediawiki-api-announce voor meldingen over wijzigingen.

Foutieve verzoeken: als de API foutieve verzoeken ontvangt, wordt er geantwoord met een HTTP-header met de sleutel "MediaWiki-API-Error" en dan worden de waarde van de header en de foutcode op dezelfde waarde ingesteld. Zie API: Foutmeldingen en waarschuwingen voor meer informatie.

Specifieke parameters:
action

Welke handeling moet worden verricht.

abusefiltercheckmatch
Controleren of een AbuseFilter overeenkomt met een serie variabelen, een bewerking of een gelogde AbuseFilter-gebeurtenis.
abusefilterchecksyntax
Controleer de syntaxis van een filter.
abusefilterevalexpression
Evalueert een misbruikfilterexpressie.
abusefilterunblockautopromote
Sta een gebruiker toe automatische promoties te krijgen als gevolg van een misbruikfilterregel.
abuselogprivatedetails
Bekijk de beperkt zichtbare gegevens van een logboekregel van het misbruikfilter.
acquiretempusername
Verkrijg een tijdelijke gebruikersnaam en bewaar deze in de huidige sessie, als de aanmaak van tijdelijke accounts is ingeschakeld en de huidige gebruiker is afgemeld. Als er al een naam is opgeslagen, wordt dezelfde naam geretourneerd.
antispoof
Een gebruikersnaam in de normaliseringscontrole van AntiSpoof opnemen.
block
Gebruiker blokkeren.
centralauthtoken
Een CentralAuthToken ophalen voor het indienen van geauthenticeerde verzoeken bij een gekoppelde wiki.
centralnoticecdncacheupdatebanner
Verzoek om het wissen van bannerinhoud die is opgeslagen in de CDN-cache (front-end) voor anonieme gebruikers, voor de gevraagde banner en taal
centralnoticechoicedata
Gegevens opvragen die nodig zijn om een banner te kiezen voor een bepaald project en een bepaalde taal
centralnoticequerycampaign
Alle instellingen van een campagne opvragen.
changeauthenticationdata
De authenticatiegegevens voor de huidige gebruiker wijzigen.
changecontentmodel
Wijzig het inhoudsmodel van een pagina
checktoken
De geldigheid van een token van action=query&meta=tokens controleren.
cirrus-config-dump
Dump van CirrusSearch-configuratie.
cirrus-mapping-dump
Dump van CirrusSearchmapping voor deze wiki.
cirrus-profiles-dump
Dump van CirrusSearch-profielen voor deze wiki.
cirrus-settings-dump
Dump van CirrusSearchinstellingen voor deze wiki.
clearhasmsg
Wist de hasmsg-vlag voor de huidige gebruiker.
clientlogin
Bij de wiki aanmelden met behulp van de interactieve flow.
compare
Het verschil tussen twee pagina's ophalen.
createaccount
Een nieuw gebruikersaccount aanmaken.
createlocalaccount
De aanmaak van een lokaal account afdwingen. Het centrale account moet bestaan.
delete
Een pagina verwijderen.
deleteglobalaccount
Een globale gebruiker verwijderen.
discussiontoolsedit
Plaats een bericht op een discussiepagina.
discussiontoolsfindcomment
Een opmerking zoeken op basis van de ID of de naam.
discussiontoolsgetsubscriptions
De abonnementsstatussen van de gegeven onderwerpen ontvangen.
discussiontoolssubscribe
Abonneer u (of meld u af) om meldingen over een onderwerp te ontvangen.
discussiontoolsthank
Een openbaar bedankje sturen voor een reactie.
echocreateevent
Handmatig een melding aan een gebruiker activeren
echomarkread
Meldingen van de huidige gebruiker markeren als gelezen.
echomarkseen
Aangeven dat de huidige gebruiker zijn of haar meldingen heeft gezien.
echomute
Meldingen van bepaalde gebruikers of pagina’s dempen of niet meer dempen.
edit
Pagina's aanmaken en bewerken.
editmassmessagelist
Een bezorglijst voor massaberichten bewerken.
emailuser
Gebruiker e-mailen.
expandtemplates
Vouwt alle sjablonen binnen wikitekst uit.
featuredfeed
Geeft een feed met uitgelichte inhoud terug.
feedcontributions
Retourneert een feed van gebruikersbijdragen.
feedrecentchanges
Retourneert een feed met recente wijzigingen.
feedwatchlist
Retourneert een volglijstfeed.
filerevert
Een oude versie van een bestand terugplaatsen.
globalblock
Een gebruiker globaal blokkeren of deblokkeren.
globalpreferenceoverrides
De lokale uitzonderingen van de globale voorkeuren van de huidige gebruiker wijzigen.
globalpreferences
De globale voorkeuren van de huidige gebruiker wijzigen.
globaluserrights
Een gebruiker toevoegen aan of verwijderen uit globale groepen.
help
Toon hulp voor de opgegeven modules.
imagerotate
Deze module is uitgeschakeld.
import
Importeer een pagina van een andere wiki, of van een XML-bestand.
jsonconfig
Verstrekt rechtstreekse toegang tot het JsonConfig-subsysteem.
languagesearch
Zoeken naar namen van talen in elk script
linkaccount
Een account van een externe provider aan de huidige gebruiker koppelen.
login
Zich aanmelden en authenticatiecookies ontvangen.
logout
Afmelden en sessiegegevens wissen.
managetags
Beheertaken uitvoeren met betrekking tot wijzigingslabels.
massmessage
Stuur een bericht naar een lijst van pagina's.
mergehistory
Geschiedenissen van pagina's samenvoegen.
move
Pagina hernoemen.
opensearch
In de wiki zoeken met behulp het OpenSearchprotocol.
options
Voorkeuren van de huidige gebruiker wijzigen.
paraminfo
Verkrijg informatie over API-modules.
parse
Ontleedt inhoud en retourneert parseruitvoer.
patrol
Een pagina of revisie als gecontroleerd markeren.
protect
Het beveiligingsniveau van een pagina wijzigen.
purge
De cache voor de opgegeven titels wissen.
query
Gegevens van en over MediaWiki ophalen.
removeauthenticationdata
De authenticatiegegevens voor de huidige gebruiker verwijderen.
resetpassword
Stuur een e-mail voor het opnieuw instellen van het wachtwoord naar een gebruiker.
revisiondelete
Versies verwijderen of terugplaatsen.
rollback
Maak de laatste bewerking van de pagina ongedaan.
rsd
Een RSD-schema (Really Simple Discovery) exporteren.
setglobalaccountstatus
Een globaal gebruikersaccount verbergen of vergrendelen (of weer zichtbaar maken of ontgrendelen).
setnotificationtimestamp
Het meldingstijdstip voor gevolgde pagina’s bijwerken.
setpagelanguage
Wijzig de taal van een pagina.
shortenurl
Verkort een lange URL in een kortere.
sitematrix
Toon een lijst met Wikimedia-sites.
spamblacklist
Controleer een of meer url's op basis van de spamblokkadelijst.
streamconfigs
Toont de configuratie van de gebeurtenisstroom. Retourneert alleen format=json met formatversion=2.
strikevote
Hiermee kunnen moderatoren stemmen doorhalen en herstellen.
tag
Wijzigingslabels aan individuele versies of logboekvermeldingen toevoegen of ervan verwijderen.
templatedata
De gegevens ophalen die zijn opgeslagen door de uitbreiding TemplateData.
thank
Stuur een bedankje naar een bewerker.
titleblacklist
Een paginatitel, bestandsnaam of gebruikersnaam valideren aan de hand van de TitleBlacklist.
torblock
Controleert of een IP-adres is geblokkeerd als Tor-exitknooppunt.
transcodereset
Gebruikers met het recht ‘transcode-reset’ kunnen een transcodeertaak afbreken en opnieuw uitvoeren.
unblock
Gebruikers deblokkeren.
undelete
Versies van een verwijderde pagina terugzetten.
unlinkaccount
Een gekoppeld account van derden van de huidige gebruiker verwijderen.
upload
Upload een bestand of bekijk de status van de uploads die in behandeling zijn.
userrights
Het groepslidmaatschap van een gebruiker wijzigen.
validatepassword
Valideer een wachtwoord tegen het wachtwoordbeleid van de wiki.
watch
De pagina aan/van de volglijst van de huidige gebruiker toevoegen/verwijderen.
webapp-manifest
Retourneert een webapp-manifest.
webauthn
API-module om te communiceren tussen server en cliënt tijdens het registratie-/authenticatieproces.
bouncehandler
Intern. Een geweigerde e-mail ontvangen en verwerken om de uitgevallen ontvanger af te handelen.
categorytree
Intern. Interne module voor de uitbreiding CategoryTree.
cirrus-check-sanity
Intern. Rapporteert over de juistheid van een reeks pagina-ID’s in de zoekindex
collection
Intern. API-module voor het uitvoeren van verscheidene bewerkingen op de verzameling van een wiki-gebruiker.
cspreport
Intern. Wordt door browsers gebruikt om schendingen van het Inhoudsveiligheidsbeleid te melden. Deze module mag nooit worden gebruikt, behalve wanneer deze automatisch wordt gebruikt door een CSP-conforme webbrowser.
discussiontoolscompare
Intern. Informatie ontvangen over commentaarwijzigingen tussen twee paginaversies.
discussiontoolspageinfo
Intern. Retourneert metagegevens die nodig zijn om de discussiehulpmiddelen te initialiseren.
discussiontoolspreview
Intern. Een voorbeeld bekijken van een bericht op een discussiepagina.
editcheckreferenceurl
Intern. Check the status of a URL for use as a reference.
fancycaptchareload
Intern. Een nieuwe FancyCaptcha ophalen.
jsondata
Intern. Gelokaliseerde JSON-gegevens ophalen.
oathvalidate
Intern. Een token voor tweetrapsauthenticatie (OATH) valideren.
parser-migration
Intern. Een pagina verwerken met twee verschillende ontleedconfiguraties.
readinglists
Intern. Schrijfbewerkingen voor leeslijsten.
sanitize-mapdata
Intern. Voert gegevensvalidatie uit voor de uitbreiding Kartographer
scribunto-console
Intern. Interne module voor het afhandelen van XHR-verzoeken vanaf de Scribunto-console.
securepollauth
Intern. Hiermee kan een externe wiki gebruikers authenticeren voordat toegang wordt verleend tot het stemmen bij de verkiezingen.
stashedit
Intern. Een bewerking voorbereiden in de gedeelde cache.
timedtext
Intern. Voorziet in geklokte tekstinhoud voor gebruik met <track>-elementen
ulslocalization
Intern. De lokalisatie van ULS in de gegeven taal opvragen.
ulssetlang
Intern. Door de gebruiker ingestelde taal bijwerken.
visualeditor
Intern. Geeft HTML5 terug voor een pagina van de Parsoid-service.
visualeditoredit
Intern. Een HTML5-pagina in MediaWiki opslaan (via Parsoid in wikitekst omgezet).
wikimediaeventsblockededit
Intern. Informatie loggen over geblokkeerde bewerkingspogingen
Een van de volgende waarden: 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, compare, createaccount, createlocalaccount, delete, deleteglobalaccount, discussiontoolsedit, discussiontoolsfindcomment, discussiontoolsgetsubscriptions, discussiontoolssubscribe, discussiontoolsthank, echocreateevent, echomarkread, echomarkseen, echomute, edit, editmassmessagelist, emailuser, expandtemplates, featuredfeed, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, globalblock, globalpreferenceoverrides, globalpreferences, globaluserrights, help, 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, tag, templatedata, thank, titleblacklist, torblock, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, webauthn, bouncehandler, categorytree, cirrus-check-sanity, collection, cspreport, discussiontoolscompare, discussiontoolspageinfo, discussiontoolspreview, editcheckreferenceurl, fancycaptchareload, jsondata, oathvalidate, parser-migration, readinglists, sanitize-mapdata, scribunto-console, securepollauth, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit, wikimediaeventsblockededit
Standaard: help
format

De opmaak van de uitvoer.

json
Toon de data in het JSON formaat.
jsonfm
Toon de data in het JSON formaat (opgemaakt in HTML).
none
Toon niets.
php
Toon de data in geserialiseerde PHP.
phpfm
Toon de data in geserialiseerde PHP (opgemaakt in HTML).
rawfm
Gegevens, inclusief debugelementen, in JSON-formaat (nette opmaak in HTML) uitvoeren.
xml
Toon de data in het XML formaat.
xmlfm
Toon de data in het XML formaat (opgemaakt in HTML).
Een van de volgende waarden: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Standaard: jsonfm
maxlag

De maximale vertraging kan gebruikt worden als MediaWiki is geïnstalleerd op een databasecluster die gebruik maakt van replicatie. Om te voorkomen dat handelingen nog meer databasereplicatievertraging veroorzaken, kan deze parameter ervoor zorgen dat de client wacht totdat de replicatievertraging lager is dan de aangegeven waarde. In geval van buitensporige vertraging wordt de foutcode maxlag teruggegeven met een bericht als Waiting for $host: $lag seconds lagged.
Zie Handleiding:Maxlag parameter voor meer informatie.

Type: integer
smaxage

Stelt de s-maxage HTTP cache controle header in op het aangegeven aantal seconden. Foutmeldingen komen nooit in de cache.

Type: integer
The value must be no less than 0.
Standaard: 0
maxage

Stelt de max-age HTTP cache controle header in op het aangegeven aantal seconden. Foutmeldingen komen nooit in de cache.

Type: integer
The value must be no less than 0.
Standaard: 0
assert

Controleren of de gebruiker is aangemeld (eventueel ook als tijdelijke gebruiker) als dit is ingesteld op user, niet is aangemeld als dit is ingesteld op anon, of het robot-gebruikersrecht heeft als dit is ingesteld op bot.

Een van de volgende waarden: anon, bot, user
assertuser

Controleer of de huidige gebruiker de genoemde gebruiker is.

Type: gebruiker, met een van gebruikersnaam en Tijdelijke gebruiker
requestid

Elke waarde die hier gegeven wordt, wordt aan het antwoord toegevoegd. Dit kan gebruikt worden om verzoeken te onderscheiden.

servedby

De hostnaam van de server die de aanvraag heeft afgehandeld aan de resultaten toevoegen.

Type: booleaans (details)
curtimestamp

Huidige tijd aan de resultaten toevoegen.

Type: booleaans (details)
responselanginfo

De voor uselang en errorlang gebruikte talen aan de resultaten toevoegen.

Type: booleaans (details)
origin

Als de API wordt benaderd met een domeinoverstijgende AJAX-aanvraag (CORS), stel dit dan in op het domein van herkomst. Dit moet worden opgenomen in elke voorafgaande aanvraag en moet daarom deel uitmaken van de URI van de aanvraag (en niet de POST-tekst).

Voor geverifieerde aanvragen moet dit exact overeenkomen met een van de oorsprongen in de header Origin. Het moet dus worden ingesteld op iets als https://nl.wikipedia.org of https://meta.wikimedia.org. Als deze parameter niet overeenkomt met de header Origin, wordt een 403-respons geretourneerd. Als deze parameter overeenkomt met de header Origin en de oorsprong is toegestaan, worden de headers Access-Control-Allow-Origin en Access-Control-Allow-Credentials ingevoegd.

Voor niet-geverifieerde aanvragen geeft u de waarde * op. Hierdoor wordt de header Access-Control-Allow-Origin ingevoegd, maar Access-Control-Allow-Credentials is false en alle gebruikerspecifieke gegevens worden afgeschermd.

uselang

Te gebruiken taal voor berichtvertalingen. action=query&meta=siteinfo&siprop=languges geeft een lijst met taalcodes terug. U kunt de gebruiker opgeven om de taalvoorkeur van de huidige gebruiker te gebruiken, of de inhoud om de inhoudstaal van deze wiki te gebruiken.

Standaard: user
variant

Variant van de taal. Werkt alleen als de basistaal variantconversie ondersteunt.

errorformat

Formaat voor het uitgeven van waarschuwings- en fouttekst

plaintext
Wikitext met HTML-tags verwijderd en entiteiten vervangen.
wikitext
Onverwerkte wikitekst.
html
HTML
raw
Berichtsleutel en parameters.
none
Geen tekstuitvoer, alleen de foutcodes.
bc
Formaat dat vóór MediaWiki 1.29 werd gebruikt. errorlang en errorsuselocal worden genegeerd.
Een van de volgende waarden: bc, html, none, plaintext, raw, wikitext
Standaard: bc
errorlang

Te gebruiken taal voor waarschuwingen en fouten. action=query&meta=siteinfo&siprop=languages geeft een lijst met taalcodes terug. Specificeer content om de inhoudstaal van deze wiki te gebruiken of uselang om dezelfde waarde te gebruiken als de parameter uselang.

Standaard: uselang
errorsuselocal

Indien ingesteld maken foutmeldingen gebruik van lokaal aangepaste berichten in de MediaWiki-naamruimte.

Type: booleaans (details)
centralauthtoken

Bij het aanspreken van de API via een domeinoverbruggend AJAX-verzoek (CORS) gebruikt u dit om u te authenticeren als de huidige SUL-gebruiker. Voordat u het CORS-verzoek indient gebruikt u eerst action=centralauthtoken op deze wiki om het token op te halen. Elk token mag maar één keer worden gebruikt en verloopt na tien seconden. Het moet worden opgenomen in elk preflight-verzoek en moet daarom in de URI van het verzoek staan (en niet in de POST-body).

Toestemming:
apihighlimits
Gebruik hogere limieten in API-aanvragen (langzame aanvragen: 500; snelle aanvragen: 5000). De limieten voor langzame aanvragen gelden ook voor parameters met meerdere waarden.
Toegekend aan: bot en sysop

Gegevenstypen

De invoer voor MediaWiki moet NFC-genormaliseerde UTF-8 zijn. MediaWiki kan proberen andere invoer om te zetten, maar daardoor kunnen sommige bewerkingen (zoals bewerkingen met MD5-controles) mislukken.

Parameters die meerdere waarden aannemen, worden normaal gesproken verzonden met de waarden gescheiden door sluistekens, bijvoorbeeld param=value1|value2 of param=value1%7Cvalue2. Als een waarde het sluisteken moet bevatten, gebruik dan U+001F (eenheidsscheidingsteken) als scheidingsteken en gebruik U+001F als voorvoegsel voor de waarde, bijvoorbeeld param=%1Fvalue1%1Fvalue2.

Sommige parametertypen in API-aanvragen behoeven nadere uitleg:

boolean

Booleaanse parameters werken als HTML-selectievakjes: als de parameter is opgegeven, ongeacht de waarde, wordt deze als true beschouwd. Voor een false-waarde laat u de parameter helemaal weg.

expiry

Vervaldata kunnen relatief zijn (bv. 5 months or 2 weeks) of absoluut (bv. 2014-09-18T12:34:56Z). Voor geen vervaldatum gebruikt u infinite, indefinite, infinity of never.

timestamp

Tijdstippen kunnen in verscheidene vormen worden opgegeven. Zie de invoerformaten van de Timestamp-bibliotheek die op mediawiki.org zijn gedocumenteerd voor meer informatie. De ISO 8601 datum- en tijdopmaak wordt aanbevolen: 2001-01-15T14:56:00Z. Bovendien kan de tekenreeks now worden gebruikt om het huidige tijdstip op te geven.

Sjabloonparameters

Sjabloonparameters ondersteunen gevallen waarin een API-module een waarde nodig heeft voor elke waarde van een andere parameter. Als er bijvoorbeeld een API-module is om fruit aan te vragen, kan deze een parameter fruits hebben om aan te geven welke vruchten worden aangevraagd en een sjabloonparameter {fruit}-quantity om aan te geven hoeveel van elke vrucht moeten worden aangevraagd. Een API-cliënt die 1 appel, 5 bananen en 20 aardbeien wil, kan dan een aanvraag doen zoals fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Vermeldingen

API-ontwikkelaars:

  • Yuri Astrakhan (oorspronkelijke ontwikkelaar, hoofdontwikkelaar september 2006 – september 2007)
  • Roan Kattouw (hoofdontwikkelaar september 2007–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Brad Jorsch (hoofdontwikkelaar 2013–2020)

Stuur uw opmerkingen, suggesties en vragen naar mediawiki-api@lists.wikimedia.org of maak een bugrapport aan op https://phabricator.wikimedia.org/.