Aide de l’API MediaWiki

Ceci est une page d’aide de l’API de MediaWiki générée (presque) automatiquement.

Documentation et exemples : https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

Cette API est accessible publiquement pour certaines parties et avec authentification pour d’autres. Son point d’entrée pour le Web est « https://fr.dicoado.org/w/api.php ».

action=linkaccount (link)

(main | linkaccount)
  • 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 :

  1. Récupérer les champs disponibles avec action=query&meta=authmanagerinfo avec amirequestsfor=link, et un jeton csrf avec action=query&meta=tokens.
  2. Présenter les champs à l’utilisateur, et les lui faire soumettre.
  3. Faire un envoi à ce module, en fournissant linkreturnurl et les champs appropriés.
  4. Vérifier le status dans la réponse.
    • Si tu as reçu PASS ou FAIL, c’est terminé. L’opération a soit réussi, soit échoué.
    • Si tu as reçu UI, affiche les nouveaux champs à l’utilisateur et fais-les-lui soumettre. Puis envoie-les à ce module avec linkcontinue et l’ensemble des champs appropriés, et recommence l’étape 4.
    • Si tu as reçu REDIRECT, envoie l’utilisateur vers la cible redirecttarget et attends le retour vers linkreturnurl. Puis envoie à ce module avec linkcontinue et tous les champs passés à l’URL de retour, puis répète l’étape 4.
    • Si tu as reçu RESTART, cela veut dire que l’authentification a fonctionné, mais nous n’avons pas de compte utilisateur lié. Tu peux traiter cela comme un UI ou un FAIL.
Paramètres :
D'autres paramètres généraux sont disponibles.
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. Cela ou linkcontinue est obligatoire.

Dès réception d’une réponse REDIRECT, tu ouvriras 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. Tu dois extraire toute requête ou paramètre POST de l’URL et les passer comme une requête linkcontinue à ce module de l’API.

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.
Exemple :
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]