API:Создание учётной записи

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page API:Account creation and the translation is 56% complete.

Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎română • ‎български • ‎русский • ‎العربية • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
Версия MediaWiki: 1.27
This page documents the account creation API as of MediaWiki 1.27. Documentation of the API as it existed in earlier versions is available here: Api:Account creation/pre-1.27 .

Документация API


action=createaccount (create)

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

Create a new user account.

The general procedure to use this module is:

  1. Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=create, and a createaccount token from action=query&meta=tokens.
  2. Present the fields to the user, and obtain their submission.
  3. Post to this module, supplying createreturnurl 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 createcontinue 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 createreturnurl. Then post to this module with createcontinue 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:
createrequests

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

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
createmessageformat

Format to use for returning messages.

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

Merge field information for all authentication requests into one array.

Type: boolean (details)
createpreservestate

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

If action=query&meta=authmanagerinfo returned true for hasprimarypreservedstate, requests marked as primary-required should be omitted. If it returned a non-empty value for preservedusername, that username must be used for the username parameter.

Type: boolean (details)
createreturnurl

Return URL for third-party authentication flows, must be absolute. Either this or createcontinue 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 createcontinue request to this API module.

createcontinue

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

Type: boolean (details)
createtoken

A "createaccount" 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=create (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.

Создание учётной записи

Процесс состоит из трёх основных этапов:

  1. Получить поля из API:Authmanagerinfo и токен из API:Токены .
  2. Отправить POST-запрос с полученным токеном, сообщающий информацию о токене и другие поля, и вернуть URL в API.
  3. Обработать ответ, который может включать запрос на дополнительные POST-запросы для предоставления дополнительной информации.

Example 1: Process on a wiki without special authentication extensions

A wiki without special authentication extensions can be rather straightforward. If your code knows which fields will be required, it might skip the call to API:Authmanagerinfo and just assume which fields will be needed (i.e. username, password & retyped password, email, possibly realname).

If you are creating an account for someone else, you'll need to specify a reason for the same by including a reason parameter to the POST request. You could also use mailpassword in place of password and retype parameters to have MediaWiki send the new user a temporary password via email.

POST-запрос

Ответ

{
    "createaccount": {
        "status": "PASS",
        "username": "Zane"
    }
}

Пример кода

create_account.py

#!/usr/bin/python3

"""
    create_account.py

    MediaWiki Action API Code Samples
    Demo of `createaccount` module: Create an account on a wiki without the 
    special authentication extensions

    MIT license
"""

import requests

S = requests.Session()

WIKI_URL = "https://test.wikipedia.org"
API_ENDPOINT = WIKI_URL + "/w/api.php"

# First step
# Retrieve account creation token from `tokens` module

PARAMS_0 = {
    'action':"query",
    'meta':"tokens",
    'type':"createaccount",
    'format':"json"
}

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

TOKEN = DATA['query']['tokens']['createaccounttoken']

# Second step
# Send a post request with the fetched token and other data (user information,
# return URL, etc.)  to the API to create an account

PARAMS_1 = {
    'action': "createaccount",
    'createtoken': TOKEN,
    'username': 'your_username',
    'password': 'your_password',
    'retype': 'retype_your_password',
    'createreturnurl': WIKI_URL,
    'format': "json"
}

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

print(DATA)

Example 2: Process on a wiki with a CAPTCHA extension

Note the first step below could, if you'd rather, be done as two steps: one to fetch the fields available from API:Authmanagerinfo and another to fetch the token from API:Токены .

First step: Fetch fields available from API:Authmanagerinfo and token from API:Токены

Second step: Send a post request along with a create account token, user information and return URL

Пример кода

Note this code sample separates the API:Authmanagerinfo and API:Токены requests, and generally assumes there will be a CAPTCHA and no other complications.

Example 3: Account creation on a wiki with a CAPTCHA, an OpenID extension, and a two-factor authentication extension enabled

First step: Fetch fields available from API:Authmanagerinfo and token from API:Токены

The fetching of API:Authmanagerinfo and API:Токены is largely the same as in the previous example, and so is not repeated here. The list of requests returned by API:Authmanagerinfo will include definitions for both the CAPTCHA extension and the OpenID extension.

Второй шаг: ответьте на капчу и выберите OpenID аутентификацию.

От клиента следует ожидать, что он перенаправит браузер пользователя на предоставленную в параметре redirecttarget цель перенаправления.

Провайдер OpenID произведёт аутентификацию и перенаправит на страницу вики Special:OpenIDConnectReturn, которая произведёт валидацию ответа OpenID и перенаправит на цель createreturnurl, предоставленную в первом POST-запросе к API, с добавленными параметрами code и state.

В этот момент клиент обратно получает управление процессом и производит свой следующий запрос API.

Третий шаг: вернитесь из OpenID.

The client posts the code and state back to the API. The API's response has the two-factor authentication extension prompting the user to set up their second factor.

Теперь клиенту следует указать призвать пользователя к созданию новой учётной записи в своём приложении для двухфакторной аутентификации и введению текущего кода, или же позволить пользователю пропустить настройку двухфакторной аутентификации. Предположим, что пользователь всё-таки настроил ДФА.

Четвёртый шаг: настройте двухфакторную аутентификацию.

Создание учётной записи наконец-то завершено.

Если в каком-либо месте произойдёт ошибка создания учётной записи, будет возвращён ответ со статусом FAIL, также будет указано сообщение message, которое следует показать пользователю.

Возможные ошибки

Код Информация
badtoken Invalid create account token
notoken Параметр token должен быть задан.
mustpostparams Следующий параметр был найден в строке запроса, но должен находиться в теле POST: createtoken.
missingparam Как минимум один из параметров "createcontinue" и "createreturnurl" обязателен.
authmanager-create-no-primary Предоставленные учётные данные не могут быть использованы для создания учётной записи.
invalidemailaddress Адрес электронной почты не может быть принят, так как он не соответствует формату.

Пожалуйста, введите корректный адрес или оставьте поле пустым.

badretype Введённые вами пароли не совпадают.
userexists Введённое имя участника уже используется.

Пожалуйста, выберите другое имя.

captcha-createaccount-fail Контрольная комбинация неверна или не введена.
acct_creation_throttle_hit Посетители этой вики, использующие ваш IP-адрес, создали num аккаунтов за последний день, что является максимумом за этот промежуток времени.

В результате, посетители с этого IP-адреса больше не могут создавать аккаунты в данный момент.

Если вы находитесь на мероприятии, фокусирующемся на вкладе в проекты Викимедиа, пожалуйста, посмотрите Запрос на временное увеличение предела IP для помощи в решении этой проблемы.

Дополнительная информация

Если вы уже вошли на сайт, при создании новой учётной записи будет в журнал будет записано и ваше текущее имя учётной записи.

  • While executing the code snippets provided on this page, remember:
    • Once an account on a wiki is created, it cannot be deleted.
    • Always use https://test.wikipedia.org/w/api.php as the endpoint, so that you don't accidentally create accounts on production wikis.
  • MediaWiki site administrators and extension developers can disable this API feature by inserting the following line in the configuration file:
$wgAPIModules['createaccount'] = 'ApiDisabled';


Смотрите также