API-sandbox

Gebruik deze pagina om te experimenteren met de MediaWiki-API. Zie de API-documentatie voor verdere details over het gebruik van de API. Voorbeeld: Zoeken naar paginatitels met een bepaald woord in de titel. Selecteer een handeling om meer voorbeelden te zien. Merk op dat hoewel dit een testfunctie is, kunnen sommige handelingen toch wijzigingen in de wiki maken.

main

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.

Testen: u kunt eenvoudig API-verzoeken testen.

Voorbeelden

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.
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.
bs-adminuser-store: Geeft een overzicht van alle gebruikers uit de database met aanvullende gevoelige gegevens. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-avatars-tasks: Gebruikersavatars uploaden, genereren en instellen
bs-book-chapters-store: Maakt het opvragen van alle boeken en de hoofdstukpagina's mogelijk.
bs-books-overview-store: Geeft een overzicht van alle boeken, inclusief boekenplank, koppeling naar het eerste hoofdstuk en handelingen.
bs-bookshelf-bookstore: Geeft een overzicht van alle hoofdstukken van een gegeven boek. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-bookshelf-manage: Voorziet in taken voor boekbewerking.
bs-bookshelf-mass-add-page-store: Voorziet in pagina's die gezamenlijk aan een boek kunnen worden toegevoegd.
bs-bookshelf-page-collection-store: Voorziet in een verzameling pagina's die gezamenlijk aan een boek kunnen worden toegevoegd.
bs-bookshelf-store: Geeft een overzicht van alle boeken. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-category-store: Geeft een overzicht van alle categorieën. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-category-treestore: Geeft de subcategorieën van een specifieke categorie weer
bs-categorylinks-store: Geeft een overzicht van alle categorieën van een pagina met verwijzingen naar de categoriepagina's, expliciete en impliciete categorieën.
bs-checklist-available-options-store: Geeft een overzicht van alle beschikbare opties voor controlelijst-sjablonen. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-checklist-tasks: Voorziet in bewerkingen voor de uitbreiding Checklist (controlelijsten)
bs-checklist-template-store: Geeft een overzicht van alle sjablonen die geldige bronnen van controlelijsten zijn. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-configmanager-store: Opslag beheren
bs-configmanager-tasks: Taken beheren
bs-contextmenu-tasks: Stelt de contextmenu-items in context beschikbaar
bs-expiry-store: Voorziet in opslag voor vervaldata en maakt het mogelijk deze op te vragen
bs-expiry-tasks: Voorziet in taken zoals het bewerken of verwijderen van vervaldata
bs-extendedsearch-autocomplete: Geeft de automatisch aangevulde resultaten van bepaalde zoekopdracht
bs-extendedsearch-query: De index doorzoeken
bs-extendedsearch-resultrelevance: Laat de relevantie van zoekresultaten zien
bs-extendedsearch-stats: Geeft statistische data over de geregistreerde zoekmachines en hun toegewezen middelen.
bs-extendedsearch-triggerupdate: Start met bijwerken van de zoekindex
bs-extendedsearch-type-store: Laat de geregistreerde zoektypen zien
bs-group-store: Geeft een overzicht van alle groepen behalve $wgImplicitGroups. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-interwiki-store: Geeft een overzicht van alle interwiki-koppelingen. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-interwikilinks-tasks: Voorziet in de taken voor de uitbreiding InterWikiLinks.
bs-js-var-config: Voorziet in een API-eindpunt voor het ophalen van configuratievariabelen bij de cliënt
bs-linker: Geeft koppelingen terug naar door Linker gegenereerde pagina's
bs-mypageassignment-store: Geeft pagina's terug die zijn toegewezen aan de huidige gebruiker
bs-namespace-store: Geeft een overzicht van alle naamruimten en willekeurige configuratie. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-namespace-tasks: Maakt het mogelijk de instellingen voor de naamruimten aan te passen.
bs-pageaccess-store: De toegang regelen op paginaniveau
bs-pageassignable-store: Geeft de lijst met toegewezenen terug
bs-pageassignment-store: Geeft toewijzingen van de specifieke pagina terug
bs-pageassignment-tasks: De lijst met toewijzingen voor een specifieke pagina ophalen of bewerken
bs-pageauthors-store: Geeft een overzicht van alle auteurs van een in de context opgegeven pagina
bs-pagetemplate-tags-store: Geeft een overzicht van alle labels van paginasjablonen. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-pagetemplates-store: Geeft een overzicht van alle paginasjablonen. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-pagetemplates-tasks: Maakt manipulatie van paginasjablonen mogelijk
bs-ping-tasks: Ping-taak die zorgt voor voortdurende uitwisseling van gegevens
bs-privacy: Eindpunt voor alle API-handelingen met betrekking tot privacy
bs-privacy-get-requests: Eindpunt voor het ophalen van alle openstaande aanvragen
bs-qr-code: QR-code ontvangen als base64-gegevens-URI voor een pagina
bs-rating-tasks: Voert veelvoorkomende taken uit voor uitbreiding Rating
bs-ratingarticle-store: Levert beoordelingen voor artikelen
bs-ratingarticlelike-store: Levert aanbevelingen voor artikelen
bs-readconfirmation-tasks: API-eindpunt voor uitbreiding ReadConfirmation
bs-readers-data-store: Verkrijg lezersinformatie van specifieke pagina.
bs-readers-page-readers-store: Verkrijg alle lezers van alle pagina's
bs-readers-revision-readers-store: Verkrijg alle lezers van alle revisies van een pagina
bs-readers-tasks: Voorziet in algemene bewerkingen voor Readers
bs-readers-users-store: Verkrijg alle lezersinformatie van specifieke pagina.
bs-recentchanges-store: Geeft een overzicht van alle recente wijzigingen. Maakt sorteren, filteren en pagineren mogelijk. Implementeert opslagparameters.
bs-reminder-store: Voorziet in opslag voor herinneringen en maakt het mogelijk deze op te vragen
bs-reminder-tasks: Voorziet in taken zoals het bewerken of verwijderen van herinneringen
bs-rss-standards-pages-store: Toon lijst van beschikbare pagina's voor RSSFeeder
bs-rssfeeder-tasks: Biedt algemene taken aan voor de RSSFeeder
bs-smw-connector-ask-store: ExtJS-compatibele opslag voor het uitvoeren van semantische zoekopdrachten
bs-smw-connector-smw-property-store: ExtJS-compatibele opslag om eigenschapswaarden op te halen
bs-smw-connector-tree-ask-store: ExtJS-compatibele boomopslag voor het uitvoeren van semantische zoekopdrachten
bs-task: Voorziet in het API-eindpunt voor het uitvoeren van geregistreerde taken
bs-templatelinks-store: Geeft een overzicht van alle sjablonen van een pagina met koppelingen naar deze sjablonen.
bs-titlequery-store: Geeft paginatitels en (optioneel) naamruimtevoorvoegsels weer op basis van een zoekterm. Implementeert ExtJS Store-parameters.
bs-upload-license-store: Geeft een overzicht van alle beschikbare licenties voor een bestandsupload
bs-usagetracker-store: Bevat statistische gegevens over het gebruik van uitbreidingen
bs-user-store: Geeft een overzicht van alle gebruikers uit de database. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-watchlist-store: Geeft een overzicht van alle volglijstvermeldingen. Maakt sorteren, filteren en pagineren mogelijk. Implementeert opslagparameters.
bs-wikiexplorer-store: Voorziet in alle gegevens voor de extensie WikiExplorer
bs-wikipage-store: Geeft een overzicht van alle wiki-pagina's. Maakt sorteren, filteren en pagineren mogelijk. Implementeert ExtJS Store-parameters.
bs-wikipage-tasks: Voorziet in algemene bewerkingen voor WikiPages
bs-wikisubpage-treestore: Geeft de subpagina's van een specifieke wikipagina weer
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.
compoundquery
cpd-diagram-usage: Het gebruik van een CPD-diagram oproepen
cpd-load-diagram: Een CPD-diagram laden
cpd-orphaned-description-pages-store: Verweesde beschrijvingspagina’s opslaan
cpd-process-overview-store: Een CPD-procesoverzicht opslaan
cpd-save-diagram: Een CPD-diagram opslaan
cpd-syntax-highlight-xml: Syntaxiskleuring toepassen op XML-inhoud
createaccount: Een nieuw gebruikersaccount aanmaken.
csdeletecomment: Een reactie verwijderen. Er moet een pagina-ID of titel worden opgegeven.
csdeletereply: Een antwoord verwijderen. Er moet een pagina-ID of titel worden opgegeven.
cseditcomment: Een bestaande reactie bewerken. Er moet een pagina-ID of titel worden opgegeven.
cseditreply: Een bestaand antwoord bewerken. Er moet een pagina-ID of titel worden opgegeven.
cspostcomment: Plaats nieuw commentaar.
cspostreply: Plaats een nieuwe reactie.
csquerycomment: Details van een reactie retourneren. Er moet een pagina-ID of titel worden opgegeven.
csqueryreply: Details van een antwoord retourneren. Er moet een pagina-ID of titel worden opgegeven.
csunwatch: Een opmerking niet meer volgen volgen om niet meer op de hoogte te worden gehouden wanneer er antwoorden worden ontvangen
csvote: Stem (omhoog, omlaag of neutraal) op een opmerking.
cswatch: Een opmerking volgen om op de hoogte te worden gehouden wanneer er antwoorden worden ontvangen
delete: Een pagina verwijderen.
edit: Pagina's aanmaken en bewerken.
emailuser: Gebruiker e-mailen.
embedvideo: Een gegenereerde video-inbedcode voor gegeven parameters ontvangen.
expandtemplates: Vouwt alle sjablonen binnen wikitekst uit.
ext.srf.datatables.api
ext.srf.slideshow.show
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.
flexiskin-activation: De activeringsmodule
flexiskin-delete: De verwijdermodule
flexiskin-preview: De voorvertoningsmodule
flexiskin-save: De opslagmodule
forms-form-submit: Biedt bewerking via formulieren
forms-get-definitions: Biedt de mogelijkheid de bestaande formulierdefinities op te vragen
getheaderfooter: De verwerkte uitvoer van een kop- of voettekst ophalen in de context van een bepaalde pagina.
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.
pagecheckout-clear: Het voorbehoud van de actieve pagina opheffen
paraminfo: Verkrijg informatie over API-modules.
parse: Ontleedt inhoud en retourneert parseruitvoer.
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: 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.
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).
tag: Wijzigingslabels aan individuele versies of logboekvermeldingen toevoegen of ervan verwijderen.
templatedata: De gegevens ophalen die zijn opgeslagen door de uitbreiding TemplateData.
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.
webauthn: API-module om te communiceren tussen server en cliënt tijdens het registratie-/authenticatieproces.
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.
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.
editcheckreferenceurl: Intern. Check the status of a URL for use as a reference.
oathvalidate: Intern. Een token voor tweetrapsauthenticatie (OATH) valideren.
scribunto-console: Intern. Interne module voor het afhandelen van XHR-verzoeken vanaf de Scribunto-console.
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).

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).

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.

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

De waarde mag niet kleiner zijn dan 0.

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

De waarde mag niet kleiner zijn dan 0.

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.

Controleer of de huidige gebruiker de genoemde gebruiker is.

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

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

Huidige tijd aan de resultaten toevoegen.

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

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.

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.

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

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.

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.

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