Jump to content

API:Users/fr: Difference between revisions

From mediawiki.org
Content deleted Content added
Created page with "=== Exemple de code ==="
FuzzyBot (talk | contribs)
Updating to match new version of source page
 
(17 intermediate revisions by 2 users not shown)
Line 4: Line 4:
'''Requête GET''' pour afficher les informations concernant une liste d'utilisateurs.
'''Requête GET''' pour afficher les informations concernant une liste d'utilisateurs.


<span id="API_documentation"></span>
== Documentation de l'API ==
== Documentation de l'API ==
{{Api help|query+users|frame=yes}}
{| style="color: black; background-color: #f8f8f8; border-spacing: 20px; border: 1px solid darkgray;"
| {{Api help|query+users}}
|}


<span id="Example"></span>
== Exemple ==
== Exemple ==


<span id="GET_request"></span>
=== Requête GET ===
=== Requête GET ===
{{ApiEx
{{ApiEx
Line 20: Line 21:
}}
}}


<span id="Response"></span>
=== Réponse ===
=== Réponse ===
<div style="width:60%;">
<div style="width:60%;">
Line 68: Line 70:
</div>
</div>


<span id="Sample_code"></span>
=== Exemple de code ===
=== Exemple de code ===


Line 73: Line 76:
{{:{{translatable}}/Sample code 1}}
{{:{{translatable}}/Sample code 1}}


<span id="Parameter_history"></span>
== Parameter history ==
== Historique des paramètres ==
* v1.29: Introduced <code>ususerids</code>, <code>userrights</code>
* v1.24: Deprecated <code>ustoken</code>
* v1.29: <code>ususerids</code>, <code>userrights</code> ajouté
* v1.18: Introduced <code>implicitgroups</code>
* v1.24: <code>ustoken</code> obsolète
* v1.17: Introduced <code>rights</code>
* v1.18: <code>implicitgroups</code> ajouté
* v1.16: Introduced <code>ususerids</code>, <code>gender</code>
* v1.17: <code>rights</code> ajouté
* v1.14: Introduced <code>emailable</code>
* v1.16: <code>ususerids</code>, <code>gender</code> ajouté
* v1.13: Introduced <code>registration</code>
* v1.14: <code>emailable</code> ajouté
* v1.13: <code>registration</code> ajouté


<span id="See_also"></span>
== See also ==
== Voir aussi ==
* {{ll|Help:User rights and groups}} - More information on user rights, and how they relate to groups
* {{ll|Help:User rights and groups}} Davantage d'information sur les droits utilisateurs et leur relation avec les groupes
* {{ll|API:User group membership}} - Adding and removing users from groups
* {{ll|API:User group membership}} Ajouter ou supprimer des utilisateurs des groupes
* {{ll|API:Allusers}} - Lists registered users in alphabetical order
* {{ll|API:Allusers}} – Liste les utilisateurs enregistrés, dans l'ordre alphabétique
* {{ll|Extension:CentralAuth/API}} - Global user info
* {{ll|Extension:CentralAuth/API}} Informations globales sur l'utilisateur

Latest revision as of 20:37, 27 October 2025

Version de MediaWiki :
1.12

Requête GET pour afficher les informations concernant une liste d'utilisateurs.

Documentation de l'API

list=users (us)

(main | query | users)

Get information about a list of users.

Specific parameters:
Other general parameters are available.
usprop

Which pieces of information to include:

blockinfo
Tags if the user is blocked, by whom, and for what reason.
groups
Lists all the groups each user belongs to.
groupmemberships
Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership.
implicitgroups
Lists all the groups a user is automatically a member of.
rights
Lists all the rights each user has.
editcount
Adds the user's edit count.
registration
Adds the user's registration timestamp.
emailable
Tags if the user can and wants to receive email through Special:Emailuser.
gender
Tags the gender of the user. Returns "male", "female", or "unknown".
centralids
Adds the central IDs and attachment status for the user.
cancreate
Indicates whether an account for valid but unregistered usernames can be created. To check whether the current user can perform the account creation, use action=query&meta=userinfo&uiprop=cancreateaccount.
tempexpired
Indicates whether the temporary account has expired or not. If account isn't temporary, null is returned.
Values (separate with | or alternative): blockinfo, cancreate, centralids, editcount, emailable, gender, groupmemberships, groups, implicitgroups, registration, rights, tempexpired
usattachedwiki

With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

ususers

A list of users to obtain information for.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).
ususerids

A list of user IDs to obtain information for.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients that are allowed higher limits).

Exemple

Requête GET

Fournit une liste des utilisateurs spécifiés -- chaque élément de la liste contenant les informations spécifiées par le paramètre usprop

Réponse

{
    "batchcomplete": "",
    "query": {
        "users": [
            {
                "name": "1.2.3.4",
                "invalid": ""
            },
            {
                "userid": 4587601,
                "name": "Catrope",
                "editcount": 359,
                "registration": "2007-06-07T16:36:03Z",
                "groups": [
                    "*",
                    "user",
                    "autoconfirmed"
                ],
                "emailable": "",
                "gender": "male"
            },
            {
                "name": "Vandal01",
                "missing": ""
            },
            {
                "userid": 2793024,
                "name": "Bob",
                "editcount": 4542,
                "registration": "2006-11-18T21:55:03Z",
                "groups": [
                    "extendedconfirmed",
                    "reviewer",
                    "*",
                    "user",
                    "autoconfirmed"
                ],
                "emailable": "",
                "gender": "male"
            }
        ]
    }
}

Exemple de code

Python

#!/usr/bin/python3

"""
    get_users.py

    MediaWiki API Demos
    Demo of `Users` module: Get information about several users:
    [[1.2.3.4]], [[Catrope]], [[Vandal01]], and [[Bob]]

    MIT License
"""

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

PARAMS = {
    "action": "query",
    "format": "json",
    "list": "users",
    "ususers": "Catrope|Bob",
    "usprop": "blockinfo|groups|editcount|registration|emailable|gender"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

USERS = DATA["query"]["users"]

for u in USERS:
    print(str(u["name"]) + " has " + str(u["editcount"]) + " edits.")

PHP

<?php
/*
    get_users.php

    MediaWiki API Demos
    Demo of `Users` module: Get information about several users: [[1.2.3.4]], [[Catrope]], [[Vandal01]], and [[Bob]]

    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "query",
    "list" => "users",
    "ususers" => "Catrope|Bob",
    "usprop" => "blockinfo|groups|editcount|registration|emailable|gender",
    "format" => "json"
];

$url = $endPoint . "?" . http_build_query( $params );

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );

$result = json_decode( $output, true );

foreach( $result["query"]["users"] as $user ){
    echo( $user["name"] . " has " . $user["editcount"] . " edits." . "\n" );
}

JavaScript

/*
    get_users.js

    MediaWiki API Demos
    Demo of `Users` module: Get information about several users: [[1.2.3.4]], [[Catrope]], [[Vandal01]], and [[Bob]]

    MIT License
*/

var url = "https://en.wikipedia.org/w/api.php"; 

var params = {
    action: "query",
    list: "users",
    ususers: "Catrope|Bob",
    usprop: "blockinfo|groups|editcount|registration|emailable|gender",
    format: "json"
};

url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});

fetch(url)
    .then(function(response){return response.json();})
    .then(function(response) {
        var users = response.query.users;
        for (var u in users) {
            console.log(users[u].name + " has " + users[u].editcount + " edits.");
        }
    })
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	get_users.js

	MediaWiki API Demos
	Demo of `Users` module: Get information about several users: [[1.2.3.4]], [[Catrope]], [[Vandal01]], and [[Bob]]

	MIT License
*/

var params = {
		action: 'query',
		list: 'users',
		ususers: 'Catrope|Bob',
		usprop: 'blockinfo|groups|editcount|registration|emailable|gender',
		format: 'json'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	var users = data.query.users,
		u;
	for ( u in users ) {
		console.log( users[ u ].name + " has " + users[ u ].editcount + " edits.");
	}
} );

Historique des paramètres

  • v1.29: ususerids, userrights ajouté
  • v1.24: ustoken obsolète
  • v1.18: implicitgroups ajouté
  • v1.17: rights ajouté
  • v1.16: ususerids, gender ajouté
  • v1.14: emailable ajouté
  • v1.13: registration ajouté

Voir aussi