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=linkaccount (link)
- Ce module nécessite des droits d’écriture.
- Ce module accepte seulement les requêtes POST.
- Source : MediaWiki
- Licence : GPL-2.0-or-later
Lier un compte d’un fournisseur tiers à l’utilisateur actuel.
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=link, ainsi qu’un jeton csrf avec action=query&meta=tokens.
- Présenter les champs à l’utilisateur et faites-les lui soumettre.
- Effectuez l’envoi à ce module, en fournissant linkreturnurl et les champs appropriés.
- Vérifiez la valeur du champ status (état) dans la réponse.
- Si vous avez reçu PASS (réussite) ou FAIL (échec), c’est terminé ; l’opération a soit réussi, soit échoué.
- Si vous avez reçu UI (interface utilisateur), affichez les nouveaux champs à l’utilisateur et faites-les lui soumettre ; puis effectuez leur envoi à ce module avec linkcontinue et l’ensemble des champs appropriés et reprenez à l’étape 4.
- Si vous avez reçu REDIRECT (redirection), dirigez l’utilisateur vers la cible indiquée dans le champ redirecttarget et attendez son retour à linkreturnurl ; puis effectuez l’envoi à ce module avec linkcontinue et tous les champs passés à l’URL de retour et reprenez à l’étape 4.
- Si vous avez reçu RESTART (redémarrer), cela veut dire que l’authentification a fonctionné, mais nous n’avons aucun compte utilisateur lié ; vous pouvez traiter cela comme une valeur UI (interface utilisateur) ou FAIL (échec).
- linkrequests
Utiliser uniquement ces requêtes d’authentification, avec l’id renvoyé par action=query&meta=authmanagerinfo avec amirequestsfor=link 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).
- linkmessageformat
Format à utiliser pour retourner les messages.
- Une des valeurs suivantes : html, none, raw, wikitext
- Par défaut : wikitext
- linkmergerequestfields
Fusionner dans un tableau le champ information de toutes les demandes d’authentification.
- Type : booléen (détails)
- linkreturnurl
Renvoyer l’URL pour les flux d’authentification tiers, qui doit être absolue. Soit celle-ci, soit linkcontinue est obligatoire.
À la réception d’une réponse REDIRECT (rédirection), vous ouvrirez typiquement un navigateur ou une vue web vers l’URL spécifiée dans le champ redirecttarget pour un flux d’authentification tiers. Une cela se termine, le tiers renverra le navigateur ou l’affichage web vers cette URL. Vous devez extraire toute requête et tous les paramètres POST de l’URL et les passer à ce module de l’API comme une requête avec linkcontinue.
- linkcontinue
Cette requête est une continuation après une précédente réponse UI ou REDIRECT. Cela ou linkreturnurl est obligatoire.
- Type : booléen (détails)
- linktoken
Un jeton « csrf » 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=link (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 liaison d’un compte depuis Exemple.
- api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [ouvrir dans le bac à sable]