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
- Bron: MediaWiki
- Licentie: GPL-2.0-or-later
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.
Testen: u kunt eenvoudig API-verzoeken testen.
- action
Welke handeling moet worden verricht.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- tag
- Add or remove change tags from individual revisions or log entries.
- 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.
- 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.
- scribunto-console
- Intern. Interne module voor het afhandelen van XHR-verzoeken vanaf de Scribunto-console.
- stashedit
- Intern. Prepare an edit in shared cache.
- Een van de volgende waarden: acquiretempusername, block, changeauthenticationdata, changecontentmodel, checktoken, clearhasmsg, clientlogin, compare, createaccount, delete, edit, emailuser, 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, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, cspreport, scribunto-console, stashedit
- 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: 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 headerOrigin
, wordt een 403-respons geretourneerd. Als deze parameter overeenkomt met de headerOrigin
en de oorsprong is toegestaan, worden de headersAccess-Control-Allow-Origin
enAccess-Control-Allow-Credentials
ingevoegd.Voor niet-geverifieerde aanvragen geeft u de waarde * op. Hierdoor wordt de header
Access-Control-Allow-Origin
ingevoegd, maarAccess-Control-Allow-Credentials
isfalse
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: boolean (details)
- Hulp voor de hoofdmodule.
- api.php?action=help [in de sandbox openen]
- Alle hulp op één pagina.
- api.php?action=help&recursivesubmodules=1 [in de sandbox openen]
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/.