Ajuda da API do MediaWiki

Esta é uma página de documentação da API do 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 requer direitos de escrita.
  • Este módulo só aceita pedidos POST.
  • Fonte: MediaWiki
  • Licença: GPL-2.0-or-later

Entrar na wiki usando o processo interativo.

O procedimento geral para usar este módulo é:

  1. Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=login e uma chave login obtida de action=query&meta=tokens.
  2. Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
  3. Publique-os para este módulo, fornecendo loginreturnurl e quaisquer campos relevantes.
  4. Verifique o valor de status na resposta.
    • Se recebeu PASS ou FAIL, terminou. A operação terá tido êxito ou falhado.
    • Se recebeu UI, apresente os novos campos ao utilizador e obtenha os dados fornecidos por este. Depois publique-os para este módulo com logincontinue e os campos relevantes preenchidos, e repita o passo 4.
    • Se recebeu REDIRECT, encaminhe o utilizador para redirecttarget e aguarde o retorno para o URL loginreturnurl. Depois publique para este módulo com logincontinue quaisquer campos que tenham sido passados ao URL de retorno, e repita o passo 4.
    • Se recebeu RESTART, isto significa que a autenticação funcionou mas não temos uma conta de utilizador associada. Pode dar-lhe o tratamento de UI ou FAIL.
Parâmetros:
loginrequests

Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=login ou por uma resposta anterior deste módulo.

Separar os valores com | ou alternativas.
O número máximo de valores é 50 (500 para clientes a quem são permitidos limites mais elevados).
loginmessageformat

Formato a usar nas mensagens de saída.

Um dos seguintes valores: html, none, raw, wikitext
Valor por omissão: wikitext
loginmergerequestfields

Combinar a informação de todos os pedidos de autenticação numa única matriz.

Tipo: booliano (detalhes)
loginpreservestate

Preservar o estado de uma tentativa de autenticação anterior falhada, se possível.

Tipo: booliano (detalhes)
loginreturnurl

O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou logincontinue.

Tipicamente, depois de receber uma resposta REDIRECT, abrirá um browser ou uma vista da Internet para o URL redirecttarget especificado, para dar lugar ao processo de autenticação por terceiros. Quando esse processo terminar, a terceira entidade encaminhará o browser ou a vista da Internet para este URL. Deve extrair do URL quaisquer parâmetros de consulta ou de POST, e passá-los como um pedido logincontinue a este módulo da API.

logincontinue

Este pedido é uma continuação após uma resposta anterior com o valor UI ou REDIRECT. É obrigatório fornecer este parâmetro ou o parâmetro loginreturnurl.

Tipo: booliano (detalhes)
logintoken

Uma chave "login" obtida 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 os pedidos disponíveis e os campos que estes utilizam.
Exemplos:
Inicia o processo de entrada na wiki com o utilizador Example e a palavra-passe ExamplePassword.
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [abrir na página de testes]
Continuar o processo de autenticação após uma resposta UI para autenticação de dois fatores, fornecendo uma OATHToken de 987654.
api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [abrir na página de testes]