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.

Parameters:
action

Welke handeling uit te voeren.

ask
API module to query Semantic MediaWiki using the ask language.
askargs
API module to query Semantic MediaWiki using the ask language as list of conditions, printouts and parameters.
block
Gebruiker blokkeren.
changeauthenticationdata
Change authentication data for the current user.
changecontentmodel
Wijzig het inhoudsmodel van een pagina
checktoken
De geldigheid van een token van action=query&meta=tokens controleren.
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.
ext.srf.slideshow.show
feedcontributions
Retourneert een feed van gebruikersbijdragen.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
Retourneert een volglijstfeed.
filerevert
Een oude versie van een bestand terugplaatsen.
googleplusprofileinfo
Makes a request to the Google+ api to find out some personal information about a given user.
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.
linkaccount
Link an account from a third-party provider to the current user.
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.
paraminfo
Verkrijg informatie over API-modules.
parse
Parses content and returns parser output.
patrol
Een pagina of revisie als gecontroleerd markeren.
pfautocomplete
Autocompletion used by the Page Forms extension.
pfautoedit
Create or edit a page using a form defined by the Page Forms extension.
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
Undo the last edit to the page.
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 to support browse activities for different entity types in Semantic MediaWiki.
smwinfo
API module to retrieve information about Semantic MediaWiki statistics and other meta information.
smwtask
API module to execute Semantic MediaWiki related tasks (for internal use only, not for public use).
spamblacklist
Validate one or more URLs against the spam block list.
tag
Add or remove change tags from individual revisions or log entries.
templatedata
Fetch data stored by the TemplateData extension.
titleblacklist
Validate a page title, filename, or username against the TitleBlacklist.
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.
browsebyproperty
Verouderd. API module to retrieve information about a property or list of properties.
browsebysubject
Verouderd. API module to retrieve information about a subject.
categorytree
Intern. Interne module voor de uitbreiding CategoryTree.
collection
Intern. API module for performing various operations on a wiki user's collection.
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. Validate a two-factor authentication (OATH) token.
scribunto-console
Intern. Internal module for servicing XHR requests from the Scribunto console.
stashedit
Intern. Prepare an edit in shared cache.
visualeditor
Intern. Returns HTML5 for a page from the Parsoid service.
visualeditoredit
Intern. Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
Een van de volgende waarden: ask, askargs, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, echomarkread, echomarkseen, echomute, edit, emailuser, expandtemplates, ext.srf.slideshow.show, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, googleplusprofileinfo, help, 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, spamblacklist, tag, templatedata, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, browsebyproperty, browsebysubject, categorytree, collection, cspreport, oathvalidate, scribunto-console, stashedit, 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

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is allowed, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

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 of the language. Only works if the base language supports variant conversion.

errorformat

Format to use for warning and error text output

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML
raw
Message key and parameters.
none
Geen tekstuitvoer, alleen de foutcodes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
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 en bot
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 en sysop

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

Vervaldatum waarden kunnen relatief (b.v. 5 months or 2 weeks) of absoluut zijn (b.v. 2014-09-18T12:34:56Z). Voor geen vervaldatum, gebruik 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 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/.