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.

block
Gebruiker blokkeren.
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
Deze module is uitgeschakeld.
delete
Een pagina verwijderen.
edit
Pagina's aanmaken en bewerken.
emailuser
Gebruiker e-mailen.
embedvideo
Get generated video embed code for given parameters.
expandtemplates
Vouwt alle sjablonen binnen wikitekst uit.
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.
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
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.
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.
setnotificationtimestamp
Het meldingstijdstip voor gevolgde pagina’s bijwerken.
setpagelanguage
Wijzig de taal van een pagina.
spamblacklist
Controleer een of meer url's op basis van de spamblokkadelijst.
tag
Wijzigingslabels aan individuele versies of logboekvermeldingen toevoegen of ervan verwijderen.
templatedata
De gegevens ophalen die zijn opgeslagen door de uitbreiding TemplateData.
titleblacklist
Een paginatitel, bestandsnaam of gebruikersnaam valideren aan de hand van de TitleBlacklist.
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.
veforall-parsoid-utils
Tekst van Wikitekst naar HTML en terug converteren
watch
De pagina aan/van de volglijst van de huidige gebruiker toevoegen/verwijderen.
categorytree
Intern. Interne module voor de uitbreiding CategoryTree.
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.
oathvalidate
Intern. Een token voor tweetrapsauthenticatie (OATH) valideren.
stashedit
Intern. Een bewerking voorbereiden in de gedeelde cache.
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: block, changeauthenticationdata, changecontentmodel, checktoken, cirrus-config-dump, cirrus-mapping-dump, cirrus-profiles-dump, cirrus-settings-dump, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, embedvideo, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, spamblacklist, tag, templatedata, titleblacklist, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, veforall-parsoid-utils, watch, categorytree, cspreport, oathvalidate, 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: geheel getal
smaxage

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

Type: geheel getal
Standaard: 0
maxage

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

Type: geheel getal
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: 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

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: booleaans (details)
Toestemmingen:
writeapi
Via de API bewerkingen uitvoeren
Toegekend aan: all, user en bot
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/.