Aide de l’API MediaWiki
Ceci est une page d’aide de l’API de MediaWiki générée automatiquement.
Documentation et exemples : https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=clientlogin (login)
- Ce module nécessite des droits d’écriture.
- Ce module n’accepte que les requêtes POST.
- Source : MediaWiki
- Licence : GPL-2.0-or-later
Se connecter au wiki en utilisant la procédure interactive.
La procédure générale pour utiliser ce module est la suivante :
- Récupérer les champs disponibles avec action=query&meta=authmanagerinfo avec amirequestsfor=login, et un jeton login avec action=query&meta=tokens.
- Présenter les champs à l’utilisateur, et les lui faire soumettre.
- Faire un envoi à ce module, en fournissant loginreturnurl et les champs appropriés.
- Vérifier le status dans la réponse.
- Si vous avez reçu PASS ou FAIL, c’est terminé. L’opération a soit réussi, soit échoué.
- Si vous avez reçu UI, affichez les nouveaux champs à l’utilisateur et faites-les-lui soumettre. Puis envoyez-les à ce module avec logincontinue et l’ensemble des champs appropriés, et recommencez l’étape 4.
- Si vous avez reçu REDIRECT, envoyez l’utilisateur vers la cible redirecttarget et attendez le retour vers loginreturnurl. Puis envoyez à ce module avec logincontinue et tous les champs passés à l’URL de retour, puis répétez l’étape 4.
- Si vous avez reçu RESTART, cela veut dire que l’authentification a fonctionné, mais nous n’avons pas de compte utilisateur lié. Vous pouvez traiter cela comme un UI ou un FAIL.
- loginrequests
Utiliser uniquement ces requêtes d’authentification, avec l’id renvoyé par action=query&meta=authmanagerinfo avec amirequestsfor=login ou depuis une réponse précédente de ce module.
- Valeurs séparées par | ou autre.
- Le nombre maximal de valeurs est 50 (ou 500 pour les clients ayant droit aux limites plus élevées).
- loginmessageformat
Format à utiliser pour retourner les messages.
- Une des valeurs suivantes : html, none, raw, wikitext
- Par défaut : wikitext
- loginmergerequestfields
Fusionner dans un tableau le champ information de toutes les demandes d’authentification.
- Type : booléen (détails)
- loginpreservestate
Conserver l’état d’une précédente tentative de connexion qui a échoué, si possible.
- Type : booléen (détails)
- loginreturnurl
Renvoyer l’URL pour les flux d’authentification tiers, qui doit être absolue. Cela ou logincontinue est obligatoire.
Dès réception d’une réponse REDIRECT, vous ouvrirez typiquement un navigateur ou un affichage web vers l’URL redirecttarget spécifiée pour un flux d’authentification tiers. Une fois ceci terminé, le tiers renverra le navigateur ou l’affichage web vers cette URL. Vous devez extraire toute requête ou paramètre POST de l’URL et les passer comme une requête logincontinue à ce module de l’API.
- logincontinue
Cette requête est une continuation après une précédente réponse UI ou REDIRECT. Cela ou loginreturnurl est obligatoire.
- Type : booléen (détails)
- logintoken
Un jeton « login » récupéré par action=query&meta=tokens
- Ce paramètre est obligatoire.
- *
- Ce module accepte des paramètres supplémentaires selon les requêtes d’authentification disponibles. Utiliser action=query&meta=authmanagerinfo avec amirequestsfor=login (ou une réponse précédente de ce module, le cas échéant) pour déterminer les requêtes disponibles et les champs qu’elles utilisent.
- Commencer le processus de connexion au wiki en tant qu’utilisateur Example avec le mot de passe ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [ouvrir dans le bac à sable]
- Continuer la connexion après une réponse de l’UI pour l’authentification à deux facteurs, en fournissant un OATHToken valant 987654.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [ouvrir dans le bac à sable]