API:Login/fr

Cette page fait partie de la documentation de l'API de MediaWiki.

API de MediaWiki

• Formats
• Erreurs retournées
• Restriction de l'utilisation (en)
• Authentification
  • Connexion
  • Déconnexion
• Requêtes (en)
  • Meta information (en)
  • Propriétés (en)
  • Révisions (en)
  • Informations sur les pages (en)
  • Listes (en)
• Expansion des modèles et rendu (en)
• Purger le cache des pages (en)
• Information sur les paramètres (en)
• Modifications (en)
  • Création de compte (en)
  • Modification/création de pages
  • Renommage de pages (en)
  • Rollback (en)
  • Import de fichiers (en)
  • Import de pages (en)
  • Suppression de pages (en)
  • Restaurer des versions supprimées (en)
  • (Dé)protection de pages (en)
  • (Dé)blocage d'utilisateurs (en)
  • (Ne plus) Suivre les pages (en)
  • Envoyer les courriels (en)
  • Patrouiller les modifications (en)
  • Gestion des groupes d'utilisateurs (en)
• Extensions de l'API (en)
• Usage interne (en)
• Autres
• Implémentation (en)
• Code client (en)

La connexion est nécessaire au serveur pour reconnaître l'utilisateur connecté. À chaque requête sur api.php, le cookie créé par la connexion doit être transmis.

Exemple

Note : Dans cet exemple, tous les paramètres sont transmis via la méthode GET pour des raisons de simplicité. Cependant, action=login nécessite la méthode POST. La méthode GET retournera une erreur.

Connexion

api.php ? action=login & lgname=Bob & lgpassword=secret

<?xml version="1.0" encoding="utf-8"?>
<api>
  <login
    result="Success"
    lguserid="12345"
    lgusername="Bob"
    lgtoken="b5780b6e2f27e20b450921d9461010b4"
    cookieprefix="enwiki"
    sessionid="08nj1ioefhlvmdjfor5to3mvv5"
  />
</api>

Vous devez ajoutez le paramètre lgdomain contenant le nom de domaine pour l'authentification si vous utilisez un greffon d'authentification comme Extension:LDAP Authentication.

Générer les cookies manuellement

Une connexion réussie créera les cookies de droits, mais si vous ne pouvez y accéder, vous pouvez aussi les générer à partir des données retournées. Dans l'exemple précédent, vous devriez générer les cookies suivants :

• enwikiUserName = Bob (valeur du champ lgusername)
• enwikiUserID = 12345 (valeur du champ lguserid)
• enwikiToken = b5780b6e2f27e20b450921d9461010b4 (valeur du champ lgtoken)
• enwiki_session = 08nj1ioefhlvmdjfor5to3mvv5 (valeur du champ sessionid)

Notez que la partie enwiki varie d'un wiki à l'autre, et est retournée dans le champ cookieprefix.

Erreurs

Les erreurs sont retournées dans le champ result. Ses valeurs possibles sont alors :

• NoName
  • Le paramètre lgname n'est pas défini.
• Illegal
  • Vous avez fourni un nom d'utilisateur illégal.
• NotExists
  • Vous avez fourni un nom d'utilisateur inexistant.
• EmptyPass
  • Le paramètre lgpassword est vide ou indéfini.
• WrongPass
  • Le mot de passe est incorrect.
• WrongPluginPass
  • Même signification que WrongPass, retourné lorsque c'est un plugin d'authentification plutôt que MediaWiki lui-même qui a rejeté le mot de passe.
• CreateBlocked
  • Le wiki a tenté de créer automatiquement un nouveau compte pour vous, mais votre adresse IP est bloquée à la création de comptes.
• NeedToWait
  • Votre délai inter-requêtes n'est pas encore écoulé. Voir ci-dessous.

Délai inter-requêtes

Pour des raisons de sécurité, ce module est protégé par un délai inter-requêtes. Une authentification qui échoue nécessite que vous attendiez 5 secondes avant de réutiliser le module ou que vous vous connectiez à partir de Special:UserLogin. Chaque tentative ratée supplémentaire doublera le délai nécessaire. Une erreur NeedToWait ne recommence pas le délai. Le nombre de secondes avant lesquelles vous pourrez réessayer est retourné dans le champ wait. Cette fonction est activée seulement dans les serveurs supportant memcaching.

Liens externes

• Exemple de connexion avec PHP ^(en) (nécessite Snoopy)