Ajuda da API MediaWiki

Esta é uma página de documentação da API MediaWiki gerada automaticamente.

Documentação e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)
  • Este módulo aceita apenas pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Faça o login no wiki usando o fluxo interativo.

O procedimento geral para usar este módulo é:

  1. Procure os campos disponíveis de action=query&meta=authmanagerinfo com amirequestsfor=login e um token login de action=query&meta=tokens.
  2. Apresentar os campos para o usuário e obtenha a sua submissão.
  3. Poste em este módulo, fornecendo loginreturnurl e quaisquer campos relevantes.
  4. Verifique o status na resposta.
    • Se você recebeu PASS ou FAIL, você terminou. A operação foi bem sucedida ou não.
    • Se você recebeu UI, apresente os novos campos ao usuário e obtenha seu envio. Em seguida, publique neste módulo com logincontinue e os campos relevantes sejam definidos e repita a etapa 4.
    • Se você recebeu REDIRECT, direcione o usuário para o redirecttarget e aguarde o retorno para loginreturnurl. Em seguida, publique neste módulo com logincontinue e quaisquer campos passados para o URL de retorno e repita a etapa 4.
    • Se você recebeu RESTART, isso significa que a autenticação funcionou mas não temos uma conta de usuário vinculada. Você pode tratar isso como UI ou como FAIL.
Parâmetros:
loginrequests

Utilize apenas estes pedidos de autenticação, pelo id retornado de action=query&meta=authmanagerinfo com amirequestsfor=login ou de uma resposta anterior deste módulo.

Valores separados com | ou alternativas.
O número máximo de valores é 50 (500 para clientes aos quais limites mais altos são permetidos).
loginmessageformat

Formato a ser usado para retornar mensagens.

Um dos seguintes valores: html, none, raw, wikitext
Padrão: wikitext
loginmergerequestfields

Fundir informações de campo para todos os pedidos de autenticação em uma matriz.

Tipo: booleano (detalhes)
loginpreservestate

Preserva o estado de uma tentativa de login anterior com falha, se possível.

Tipo: booleano (detalhes)
loginreturnurl

O URL de retorno para fluxos de autenticação de terceiros deve ser absoluto. Isso ou logincontinue é necessário.

Quando receber uma resposta REDIRECT, você normalmente abrirá um navegador ou uma visão da web para o redirecttarget URL para um fluxo de autenticação de terceiros. Quando isso for concluído, o terceiro enviará ao navegador ou a web para este URL. Você deve extrair qualquer consulta ou parâmetros POST do URL e passá-los como uma solicitação logincontinue para este módulo de API.

logincontinue

Esse pedido é uma continuação após uma resposta UI ou REDIRECT anterior. Ou loginreturnurl é requerido.

Tipo: booleano (detalhes)
logintoken

Um token "login" token recuperado de action=query&meta=tokens

Este parâmetro é obrigatório.
*
Este módulo aceita parâmetros adicionais dependendo dos pedidos de autenticação disponíveis. Use action=query&meta=authmanagerinfo com amirequestsfor=login (ou uma resposta anterior deste módulo, se aplicável) para determinar as solicitações disponíveis e os campos que eles usam.
Exemplos:
Comeca o processo de logar na wiki como usuário Exemple com a senha ExamplePassword.
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [abrir na página de testes]
Continuar efetuando login após uma resposta UI para autenticação de dois fatores, fornecendo um OATHToken de 987654</ kbd>.
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [abrir na página de testes]