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
action=clientlogin (login)
- Voor deze module zijn schrijfrechten nodig.
- Deze module accepteert alleen POST-verzoeken.
- Bron: MediaWiki
- Licentie: GPL-2.0-or-later
Bij de wiki aanmelden met behulp van de interactieve flow.
De algemene procedure om deze module te gebruiken is:
- Haal de beschikbare velden op van action=query&meta=authmanagerinfo met amirequestsfor=login en een token login van action=query&meta=tokens.
- Presenteer de velden aan de gebruiker en ontvang de inzending ervan.
- Post naar deze module en geef loginreturnurl en alle relevante velden op.
- Controleer de status in het antwoord.
- Als u PASS of FAIL hebt ontvangen, bent u klaar. De bewerking is of geslaagd of mislukt.
- Als u UI hebt ontvangen, presenteer dan de nieuwe velden aan de gebruiker en ontvang de inzending ervan. Post vervolgens naar deze module met logincontinue en met de relevante velden ingesteld, en herhaal stap 4.
- Als u REDIRECT hebt ontvangen, stuurt u de gebruiker door naar het doorverwijzingsdoel redirecttarget en wacht u op de terugkeer naar loginreturnurl. Post vervolgens naar deze module met logincontinue en met alle velden die zijn doorgegeven aan de terugkeer-URL, en herhaal stap 4.
- Als u RESTART hebt ontvangen, betekent dit dat de authenticatie is gelukt, maar dat we geen gekoppeld gebruikersaccount hebben. U kunt dit behandelen als UI of als FAIL.
- loginrequests
Gebruik alleen deze authenticatieverzoeken, via de id die wordt geretourneerd door action=query&meta=authmanagerinfo met amirequestsfor=login of via een eerder antwoord van deze module.
- Scheid waarden met | of een alternatief.
- Maximumaantal waarden is 50 (of 500 voor cliënten waaraan hogere limieten zijn toegestaan).
- loginmessageformat
De voor het retourneren van berichten te gebruiken indeling.
- Een van de volgende waarden: html, none, raw, wikitext
- Standaard: wikitext
- loginmergerequestfields
Veldinformatie voor alle authenticatieverzoeken in één array samenvoegen.
- Type: booleaans (details)
- loginpreservestate
Indien mogelijk de toestand van een eerdere mislukte aanmeldpoging behouden.
- Type: booleaans (details)
- loginreturnurl
Retour-URL voor authenticatiestromen van derden, moet absoluut zijn. Dit of logincontinue is vereist.
Na ontvangst van een REDIRECT-respons opent u doorgaans een browser of webweergave naar de opgegeven redirecttarget-URL voor een authenticatiestroom van derden. Wanneer dat is voltooid, stuurt de derde de browser of webweergave naar deze URL. U moet alle query- of POST-parameters uit de URL halen en deze als een logincontinue-verzoek doorgeven aan deze API-module.
- logincontinue
Dit verzoek is een voortzetting na een eerdere UI- of REDIRECT-respons. Of dit of loginreturnurl is vereist.
- Type: booleaans (details)
- logintoken
Een token “login” dat is verkregen uit action=query&meta=tokens
- Deze parameter is vereist.
- *
- Deze module accepteert aanvullende parameters afhankelijk van de beschikbare authenticatieverzoeken. Gebruik action=query&meta=authmanagerinfo met amirequestsfor=login (of een eerdere respons van deze module, indien van toepassing) om de beschikbare verzoeken en de velden die ze gebruiken te bepalen.
- Start het aanmeldproces als gebruiker Example met wachtwoord ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [in de sandbox openen]
- Doorgaan met aanmelden na een UI-respons voor tweetrapsauthenticatie, met 987654 als OATHToken.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [in de sandbox openen]