MediaWiki API hulp

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Main module

Status: De MediaWiki API is een stabiele interface die actief ondersteund en verbeterd wordt. Hoewel we het proberen te voorkomen, is het mogelijk dat er soms wijzigingen worden aangebracht die bepaalde API-verzoek kunnen verhinderen; 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 daarna 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.

ask
API-module om Semantic MediaWiki te bevragen met behulp van de taal “ask”.
askargs
API-module om Semantic MediaWiki te bevragen met behulp van de taal “ask” aan de hand van een lijst met voorwaarden, uitvoeraanwijzingen en parameters.
block
Gebruiker blokkeren.
cargoautocomplete
Aanroep voor automatisch aanvullen gebruikt door de Cargo-extensie.
cargofields
Haalt alle velden op in de opgegeven tabel
cargoformatparams
Haalt de set weergaveparameters op voor elk Cargo-queryformaat.
cargoquery
Voert een query uit op de Cargo-gegevens.
cargoqueryautocomplete
Aanroep voor automatisch aanvullen gebruikt door de speciale pagina CargoQuery (voorheen ViewData).
cargorecreatedata
Vult de gegevens in een Cargo-tabel opnieuw in.
cargorecreatespecialtable
Maakt een speciale Cargo-tabel aan.
cargorecreatetables
Maakt een of meer Cargo-tabellen opnieuw aan.
cargotables
Haalt alle tabellen in het systeem op
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.
delete
Een pagina verwijderen.
echomarkread
Meldingen van de huidige gebruiker markeren als gelezen.
echomarkseen
Aangeven dat de huidige gebruiker zijn of haar meldingen heeft gezien.
echomute
Mute or unmute notifications from certain users or pages.
edit
Pagina's aanmaken en bewerken.
emailuser
Gebruiker e-mailen.
expandtemplates
Vouwt alle sjablonen binnen wikitekst uit.
feedcontributions
Retourneert een feed van gebruikersbijdragen.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
Retourneert een volglijstfeed.
filerevert
Een oude versie van een bestand terugplaatsen.
help
Toon hulp voor de opgegeven modules.
imagerotate
Een of meerdere afbeeldingen draaien.
import
Importeer een pagina van een andere wiki, of van een XML-bestand.
languagesearch
Search for language names in any script.
linkaccount
Link an account from a third-party provider to the current user.
linksuggest
Koppeling voorstellen aan bewerkers tijdens het bewerken
login
Log in and get authentication cookies.
logout
Afmelden en sessiegegevens wissen.
managetags
Perform management tasks relating to change tags.
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.
pageownership-check-latest-version
check extension's latest version
pageownership-get-permissions
pageownership get permissions
pageownership-set-permissions
pageownership set permissions
paraminfo
Verkrijg informatie over API-modules.
parse
Parses content and returns parser output.
patrol
Een pagina of revisie als gecontroleerd markeren.
pfautocomplete
Automatisch aanvullen gebruikt door de uitbreiding Paginaformulieren.
pfautoedit
Maak of bewerk een pagina met behulp van een formulier dat is gedefinieerd door de uitbreiding Paginaformulieren.
protect
Change the protection level of a page.
purge
Purge the cache for the given titles.
query
Fetch data from and about MediaWiki.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
revisiondelete
Versies verwijderen of terugplaatsen.
rollback
Maak de laatste bewerking van de pagina ongedaan.
rsd
Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Wijzig de taal van een pagina.
smwbrowse
API-module ter ondersteuning van het doorbladeren van verschillende entiteitstypen in Semantic MediaWiki.
smwinfo
API-module om informatie op te halen over Semantic MediaWiki-statistieken en andere metagegevens.
smwtask
API-module om Semantic MediaWiki-gerelateerde taken uit te voeren (alleen voor intern gebruik, niet voor openbaar gebruik).
spamblacklist
Controleer een of meer url's op basis van de spamblokkadelijst.
tag
Add or remove change tags from individual revisions or log entries.
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.
transcodereset
Gebruikers met het recht ‘transcode-reset’ kunnen een transcodeertaak afbreken en opnieuw uitvoeren.
unblock
Gebruikers deblokkeren.
undelete
Undelete 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
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.
browsebyproperty
Verouderd. API-module om informatie over een eigenschap of een lijst met eigenschappen op te vragen.
browsebysubject
Verouderd. API-module om informatie over een onderwerp op te vragen.
categorytree
Intern. Interne module voor de uitbreiding CategoryTree.
collection
Intern. API-module voor het uitvoeren van verscheidene bewerkingen op de verzameling van een wiki-gebruiker.
cspreport
Intern. Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
oathvalidate
Intern. Een token voor tweefactorauthenticatie (OATH) valideren.
scribunto-console
Intern. Interne module voor het afhandelen van XHR-verzoeken vanaf de Scribunto-console.
stashedit
Intern. Prepare an edit in shared cache.
timedtext
Intern. Voorziet in geklokte tekstinhoud voor gebruik met <track>-elementen
ulslocalization
Intern. Get the localization of ULS in the given language.
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).
Een van de volgende waarden: ask, askargs, block, cargoautocomplete, cargofields, cargoformatparams, cargoquery, cargoqueryautocomplete, cargorecreatedata, cargorecreatespecialtable, cargorecreatetables, cargotables, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, delete, echomarkread, echomarkseen, echomute, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, languagesearch, linkaccount, linksuggest, login, logout, managetags, mergehistory, move, opensearch, options, pageownership-check-latest-version, pageownership-get-permissions, pageownership-set-permissions, paraminfo, parse, patrol, pfautocomplete, pfautoedit, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, smwbrowse, smwinfo, smwtask, spamblacklist, tag, templatedata, thank, titleblacklist, transcodereset, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, webapp-manifest, browsebyproperty, browsebysubject, categorytree, collection, cspreport, oathvalidate, scribunto-console, stashedit, timedtext, ulslocalization, ulssetlang, visualeditor, visualeditoredit
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
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
Standaard: 0
assert

Controleer of de gebruiker is aangemeld indien assert=user, niet is aangemeld is indien assert=anon, of het botgebruikersrecht heeft indien assert=bot.

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

Controleer of de huidige gebruiker de genoemde gebruiker is.

Type: gebruiker, met gebruikersnaam
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: boolean (details)
curtimestamp

Huidige tijd aan de resultaten toevoegen.

Type: boolean (details)
responselanginfo

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

Type: boolean (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

Taal om te gebruiken voor berichtvertalingen. action=query&meta=siteinfo gecombineerd met siprop=languages toont een lijst met taalcodes. De waarde user gebruikt de taal die door de huidige gebruiker als voorkeur is ingesteld. De waarde content gebruikt de taal die de inhoud op de wiki heeft.

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

De voor waarschuwingen en fouten te gebruiken taal. action=query&meta=siteinfo met siprop=languages geeft een lijst van taalcodes, of stel content in om de taal van de inhoud van deze wiki te gebruiken, of stel uselang in om dezelfde waarde als de parameter uselang te gebruiken.

Standaard: uselang
errorsuselocal

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

Type: boolean (details)
Toestemmingen:
writeapi
Via de API bewerkingen uitvoeren
Toegekend aan: all, user, bot en staff
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Toegekend aan: bot, sysop en staff

Gegevenstypen

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

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

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 parameters

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like 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/.