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/API
action=linkaccount (link)
- Este módulo requer direitos de escrita.
- Este módulo só aceita pedidos POST.
- Fonte: MediaWiki
- Licença: GPL-2.0-or-later
Ligar uma conta de um fornecedor terceiro ao utilizador atual.
O procedimento geral para usar este módulo é:
- Obtenha os campos disponíveis usando action=query&meta=authmanagerinfo com amirequestsfor=link e uma chave csrf obtida de action=query&meta=tokens.
- Apresente os campos ao utilizador e obtenha os dados fornecidos por este.
- Publique-os para este módulo, fornecendo linkreturnurl e quaisquer campos relevantes.
- 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 linkcontinue 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 linkreturnurl. Depois publique para este módulo com linkcontinue 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.
- linkrequests
Usar só estes pedidos de autenticação, com o id devolvido por action=query&meta=authmanagerinfo com amirequestsfor=link ou por uma resposta anterior deste módulo.
- Separar os valores com | ou alternativas. O número máximo de valores é 50 (500 para robôs).
- linkmessageformat
Formato a usar nas mensagens de saída.
- Um dos seguintes valores: html, wikitext, raw, none
- Valor por omissão: wikitext
- linkmergerequestfields
Combinar a informação de todos os pedidos de autenticação numa única matriz.
- Tipo: booliano (detalhes)
- linkreturnurl
O URL de retorno para processos de autenticação por terceiros tem de ser absoluto. É obrigatório fornecer este URL ou linkcontinue.
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 linkcontinue a este módulo da API.
- linkcontinue
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 linkreturnurl.
- Tipo: booliano (detalhes)
- linktoken
Uma chave "csrf" 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=link (ou uma resposta anterior deste módulo, se aplicável) para determinar os pedidos disponíveis e os campos que estes utilizam.
- Iniciar o processo de ligação a uma conta do fornecedor Example.
- api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [abrir na página de testes]