API:Oturum aç

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Login and the translation is 100% complete.
Other languages:
Bahasa Melayu • ‎Deutsch • ‎Deutsch (Sie-Form)‎ • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎українська • ‎العربية • ‎فارسی • ‎ไทย • ‎中文 • ‎文言 • ‎日本語 • ‎한국어

MediaWiki API, uygulamanızın veya istemcinizin kimliği doğrulanmış kullanıcı kimlik bilgileri sağlamasını ve (a) bilgi sorgulama veya veri değiştirme eylemleri (b) daha yüksek istek başına istek sınırına sahip büyük sorgular yapmak için oturum açmasını gerektirebilir.

Kimlik doğrulamanın iki yöntemi

MediaWiki Eylem API'sinde kimlik doğrulamanın iki yolu vardır:

Yöntem 1. oturum aç

Botlar ve diğer etkileşimli olmayan uygulamalar, daha güvenli olduğu sürece yalnızca sahip OAuth tüketiciler kullanmalıdır. İstemci için kullanılamıyorsa veya uygulanamıyorsa, bot parolaları ile login eylemi kullanılabilir.

API belgesi


action=login (lg)

(main | login)
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Log in and get authentication cookies.

This action should only be used in combination with Special:BotPasswords; use for main-account login is deprecated and may fail without warning. To safely log in to the main account, use action=clientlogin.

Parameters:
lgname

User name.

lgpassword

Password.

lgdomain

Domain (optional).

lgtoken

A "login" token retrieved from action=query&meta=tokens

Örnek

POST isteği

Yukarıdaki istekte lgtoken, API:Tokens üzerinden alındı

Yanıt

{  
   "login": {  
      "lguserid": 21,
      "result": "Success",
      "lgusername": "William"
   }
}

Örnek kod

MediaWiki JS

/*
	login.js
	MediaWiki API Demos
	Demo of `Login` module: Sending request to login
	MIT License
*/

var api = new mw.Api();

api.login( 'your_bot_username', 'your_bot_password' ).done( function ( data ) {
	console.log( 'You are logged in as ' + data.login.lgusername );
} );

JavaScript

/*
	edit.js

	MediaWiki API Demos
	Demo of `Login` module: Sending post request to login

	MIT license
*/

var request = require( 'request' ).defaults( { jar: true } ),
	url = 'https://test.wikipedia.org/w/api.php';

// Step 1: GET request to fetch login token
function getLoginToken() {
	var params = {
		action: 'query',
		meta: 'tokens',
		type: 'login',
		format: 'json'
	};

	request.get( { url: url, qs: params }, function ( error, res, body ) {
		var data;
		if ( error ) {
			return;
		}
		data = JSON.parse( body );
		loginRequest( data.query.tokens.logintoken );
	} );
}

// Step 2: POST request to log in.
// Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest( loginToken ) {
	var params = {
		action: 'login',
		lgname: 'bot_username',
		lgpassword: 'bot_password',
		lgtoken: loginToken,
		format: 'json'
	};

	request.post( { url: url, form: params }, function ( error, res, body ) {
		if ( error ) {
			return;
		}
		console.log( body );
	} );
}

// Start From Step 1
getLoginToken();

PHP

<?php

/*
    login.php

    MediaWiki API Demos
    Demo of `Login` module: Sending post request to login
    MIT license
*/

$endPoint = "https://test.wikipedia.org/w/api.php";

$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2

// Step 1: GET request to fetch login token
function getLoginToken() {
	global $endPoint;

	$params1 = [
		"action" => "query",
		"meta" => "tokens",
		"type" => "login",
		"format" => "json"
	];

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

	$ch = curl_init( $url );
	curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
	curl_setopt( $ch, CURLOPT_COOKIEJAR, "/tmp/cookie.txt" );
	curl_setopt( $ch, CURLOPT_COOKIEFILE, "/tmp/cookie.txt" );

	$output = curl_exec( $ch );
	curl_close( $ch );

	$result = json_decode( $output, true );
	return $result["query"]["tokens"]["logintoken"];
}

// Step 2: POST request to log in. Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest( $logintoken ) {
	global $endPoint;

	$params2 = [
		"action" => "login",
		"lgname" => "your_bot_username",
		"lgpassword" => "your_bot_password",
		"lgtoken" => $logintoken,
		"format" => "json"
	];

	$ch = curl_init();

	curl_setopt( $ch, CURLOPT_URL, $endPoint );
	curl_setopt( $ch, CURLOPT_POST, true );
	curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params2 ) );
	curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
	curl_setopt( $ch, CURLOPT_COOKIEJAR, "/tmp/cookie.txt" );
	curl_setopt( $ch, CURLOPT_COOKIEFILE, "/tmp/cookie.txt" );

	$output = curl_exec( $ch );
	curl_close( $ch );

	echo( $output );
}

Python

#!/usr/bin/python3

"""
    login.py

    MediaWiki API Demos
    Demo of `Login` module: Sending post request to login
    MIT license
"""

import requests

S = requests.Session()

URL = "https://www.mediawiki.org/w/api.php"

# Retrieve login token first
PARAMS_0 = {
    'action':"query",
    'meta':"tokens",
    'type':"login",
    'format':"json"
}

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

LOGIN_TOKEN = DATA['query']['tokens']['logintoken']

print(LOGIN_TOKEN)

# Send a post request to login. Using the main account for login is not
# supported. Obtain credentials via Special:BotPasswords
# (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword

PARAMS_1 = {
    'action':"login",
    'lgname':"your_bot_username",
    'lgpassword':"your_bot_password",
    'lgtoken':LOGIN_TOKEN,
    'format':"json"
}

R = S.post(URL, data=PARAMS_1)
DATA = R.json()

print(DATA)
MediaWiki 1.27'den itibaren, oturum açma için ana hesabın kullanılması desteklenmemektedir. Special:BotPasswords yoluyla kimlik bilgilerini alın veya clientlogin yöntemini kullanın. Oturum açmak ve oturumunuzu açık tutmak, istemcinizin tüm istekler üzerinde doğru HTTP çerez işlemesini gerektirir. Yukarıdaki örnekte, requests.Session() oturum nesnesinin çerezlerin kalıcı olmasına nasıl yardımcı olduğunu gösteriyoruz.

Olası hatalar

Kod Bilgi
Failed Geçersiz kullanıcı adı ve parola. Lütfen tekrar deneyiniz.
WrongToken Geçersiz anahtar sağlandı
NeedToken `lgtoken` sağlanmadı
Aborted bot parolaları yerine ana hesap parolasını kullanarak oturum açın
mustpostparams Sorgu dizesinde şu parametresi bulundu, ancak POST gövdesinde olması gerekiyor: $1.

Yöntem 2. kullanıcı oturumu

Web sitesini veya web tabanlı kullanıcı arabirimine erişimi tamamen değiştirmeyi amaçlayan mobil uygulamaları tamamen değiştirmeyi amaçlamadan hizmet sağlayan özel editörler veya devriye uygulamaları gibi etkileşimli uygulamalar clientlogin eylemini kullanmalıdır. Bununla birlikte, aracın kimliğini doğrulamak için mevcutsa, daha kolay ve daha güvenli olduğu için OAuth kullanmayı tercih etmelisiniz. Bu modül MediaWiki 1.27'den beri mevcuttur.

API belgesi


action=clientlogin (login)

(main | clientlogin)
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Log in to the wiki using the interactive flow.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=login, and a login token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying loginreturnurl and any relevant fields.
  4. Check the status in the response.
    • If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
    • If you received UI, present the new fields to the user and obtain their submission. Then post to this module with logincontinue and the relevant fields set, and repeat step 4.
    • If you received REDIRECT, direct the user to the redirecttarget and wait for the return to loginreturnurl. Then post to this module with logincontinue and any fields passed to the return URL, and repeat step 4.
    • If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
Parameters:
loginrequests

Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.

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

Format to use for returning messages.

One of the following values: html, none, raw, wikitext
Default: wikitext
loginmergerequestfields

Merge field information for all authentication requests into one array.

Type: boolean (details)
loginpreservestate

Preserve state from a previous failed login attempt, if possible.

Type: boolean (details)
loginreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.

Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a logincontinue request to this API module.

logincontinue

This request is a continuation after an earlier UI or REDIRECT response. Either this or loginreturnurl is required.

Type: boolean (details)
logintoken

A "login" token retrieved from action=query&meta=tokens

This parameter is required.
*
This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=login (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
Examples:
Start the process of logging in to the wiki as user Example with password ExamplePassword.
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [open in sandbox]
Continue logging in after a UI response for two-factor auth, supplying an OATHToken of 987654.
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [open in sandbox]

Örnek 1: Özel kimlik doğrulama uzantıları olmayan bir viki için işlem

POST isteği

Yukarıdaki istekte API:Tokens ile anahtar oturumu alın.

Yanıt

{  
   "clientlogin":{  
      "status":"PASS",
      "username":"William"
   }
}

Örnek kod

Örnek 2: Özel kimlik doğrulama uzantılarına sahip bir viki işlemi

ConfirmEdit (captcha), OpenID , OATHAuth (iki faktörlü kimlik doğrulama) gibi özel kimlik doğrulama uzantılarına sahip bir vikinin daha karmaşık bir kimlik doğrulama işlemi olabilir. Bu durumda, açıklaması API:Authmanagerinfo sorgusundan alınabilecek belirli alanlar da gerekli olabilir.

Adım 1: Captcha'ya cevap verin ve OpenID kimlik doğrulamasını seçin

İstemciden kullanıcının tarayıcısını sağlanan redirecttarget yönlendirmesi beklenir. OpenID sağlayıcı kimlik doğrulaması yapar ve vikide OpenID yanıtını doğrular ve daha sonra code ve state parametreleri eklendi. İstemci bu noktada sürecin kontrolünü ele geçirir ve bir sonraki API isteğini yapar.

Adım 2: OpenID'den geri

Şimdi istemcinin geçerli kod için kullanıcıdan iki faktörlü kimlik doğrulama uygulamasını kontrol etmesini istemesi ve kimlik doğrulama işlemine devam etmek için bunu sunucuya geri göndermesi gerekir.

3. Adım: İki faktörlü kimlik doğrulama

Not: Belirli durumlarda RESTART yanıtı almak mümkündür; örneğin, OpenID Connect uzantısında herhangi bir yerel kullanıcı için OpenID hesabı için eşleme yoksa. Bu durumda, istemci oturum açma işlemini baştan başlatabilir veya bazı durumlarda korumak için loginpreservestate veya createpreservestate parametresini geçerek hesap oluşturmaya geçebilir.

Ek notlar

  • Anonim düzenlemeye izin veren vikilerde, giriş yapmadan API aracılığıyla düzenleme yapmak mümkündür, ancak oturum açmanıza önemle tavsiye edilir. Özel vikilerde, herhangi bir API işlevini kullanmak için oturum açmak gerekir.
  • Uygulamanız için ayrı bir kullanıcı hesabı oluşturmanız önerilir. Bu, uygulamanız otomatik düzenleme veya büyük veya performans açısından yoğun sorgular yürütüyorsa özellikle önemlidir. Bununla, uygulama tarafından yapılan değişiklikleri izlemek ve uygulamanın hesabına özel haklar uygulamak kolaydır.
  • Oturum açmış bir kullanıcı tarafından yapılması gereken bir istek gönderiyorsanız, kullanıcının oturum açıp açmadığını kontrol etmek için gönderdiğiniz talebe assert=user parametresi ekleyin. Kullanıcı oturum açmamışsa, assertuserfailed hata kodu döndürülür.
  • Bir hesabın bot haklarına sahip olup olmadığını kontrol etmek için, isteğe assert=bot parametresi ekleyin. Hesabın bot hakları yoksa, assertbotfailed hata kodu döndürülür.

Ayrıca bakınız