API: Utilizadores
Appearance
From mediawiki.org
This page is a translated version of the page API:Users and the translation is 100% complete.
Languages:
Está página faz parte da documentação da API de Ação do MediaWiki.
| API de Ação do MediaWiki |
|---|
| Elementar |
| Autenticação |
| Contas e Utilizadores |
| Operações de Página |
|
| Pesquisar |
| Utilitários do Programador |
| Tutoriais |
| v · d · e |
Versão MediaWiki:
≥ 1.12
Pedido "GET" para ver a informação sobre uma lista de utilizadores.
Documentação da API
A documentação a seguir é a saída de Special: ApiHelp/ query+users, gerada automaticamente pela versão de pré-lançamento do MediaWiki em execução neste site (MediaWiki.org).
list=users (us)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0-or-later
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).
Example:
- Return information for user Example.
- api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [open in sandbox]
Exemplo
Pedido "GET"
Obtém uma lista dos utilizadores especificados - cada item na lista contém informação especificada pelo parâmetro
uspropapi.php? action=query& list=users& ususers=1.2.3.4|Catrope|Vandal01|Bob& usprop=blockinfo|groups|editcount|registration|emailable|gender [teste na 'Área de Testes' da API (Sandbox)]
Resposta
{ "batchcomplete":"", "query":{ "users":[ { "name":"1.2.3.4", "invalid":"" }, { "userid":4587601, "name":"Catrope", "editcount":359, "registration":"2007年06月07日T16:36:03Z", "groups":[ "*", "user", "autoconfirmed" ], "emailable":"", "gender":"male" }, { "name":"Vandal01", "missing":"" }, { "userid":2793024, "name":"Bob", "editcount":4542, "registration":"2006年11月18日T21:55:03Z", "groups":[ "extendedconfirmed", "reviewer", "*", "user", "autoconfirmed" ], "emailable":"", "gender":"male" } ] } }
Código amostra
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 """ importrequests 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 */ varurl="https://en.wikipedia.org/w/api.php"; varparams={ 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){returnresponse.json();}) .then(function(response){ varusers=response.query.users; for(varuinusers){ 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 */ varparams={ action:'query', list:'users', ususers:'Catrope|Bob', usprop:'blockinfo|groups|editcount|registration|emailable|gender', format:'json' }, api=newmw.Api(); api.get(params).done(function(data){ varusers=data.query.users, u; for(uinusers){ console.log(users[u].name+" has "+users[u].editcount+" edits."); } });
Histórico de parâmetros
- v1.29: Introduzido
ususerids,userrights - v1.24: Desaprovado
ustoken - v1.18: Introduzido
implicitgroups - v1.17: Introduzido
rights - v1.16: Introduzido
ususerids,gender - v1.14: Introduzido
emailable - v1.13: Introduzido
registration
Consultar também
- Ajuda: Direitos de Utilizador e de Grupos – Mais informação sobre os direitos de utilizador, e como se relacionam com os grupos
- API: Membro do grupo de utilizadores – Adicionar e remover utilizadores dos grupos
- API:Allusers – Lista de utilizadores registados por ordem alfabética
- Extension:CentralAuth/API – Informação global do utilizador