Axuda da API de MediaWiki
Esta é unha páxina de documentación da API de MediaWiki xerada automaticamente.
Documentación e exemplos: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=clientlogin (login)
- Este módulo precisa permisos de escritura.
- Este módulo só acepta peticións POST.
- Fonte: MediaWiki
- Licenza: GPL-2.0-or-later
Conectarse á wiki usando o fluxo interactivo.
O procedemento xeral para usar este módulo é:
action=query&meta=authmanagerinfo con amirequestsfor=login, e un identificador login de action=query&meta=tokens.
- Presentar os campos ó usuario, e obter o seu envío.
- Enviar a este módulo, proporcionando loginreturnurl e calquera campo relevante.
- Comprobar o status na resposta.
- Se vostede recibe PASS ou FAIL, a acción rematou. A operación foi correcta ou non se fixo.
- Se vostede recibe UI, presenta os novos campos ó usuario e obtén o seu envío. Logo son enviados a este módulo con logincontinue e o conxunto de campos relevantes, e repite o paso 4.
- Se vostede recibe REDIRECT, dirixe ó usuario a redirecttarget e espera pola resposta a loginreturnurl. Logo envíaa a este módulo con logincontinue e calquera campo pasado á URL de volta, e repite o paso 4.
- Se recibe RESTART, isto significa que a autenticación funcionou pero que non temos unha conta de usuario ligada. Debe tratar isto igual que UI ou como FAIL.
- loginrequests
Só usar estas peticións de autenticación, co id devolto por action=query&meta=authmanagerinfo con amirequestsfor=login ou dunha resposta previa deste módulo.
- Separe os valores con | ou outros.
- O número máximo de valores é 50 (500 para os clientes aos que se lles permiten límites máis altos).
- loginmessageformat
Formato a usar para devolver as mensaxes.
- Un valor dos seguintes valores: html, none, raw, wikitext
- Por defecto: wikitext
- loginmergerequestfields
Fusionar os campos de información para todas as peticións de autenticación nunha táboa.
- Tipo: booleano (detalles)
- loginpreservestate
Conservar o estado dun intento previo de conexión fallida, se é posible.
- Tipo: booleano (detalles)
- loginreturnurl
Devolve o URL para os fluxos de autenticación de terceiros, que debe ser absoluto. Este ou logincontinue é obrigatorio.
Logo da recepción dunha resposta REDIRECT, vostede normalmente abrirá un navegador web ou un visor web para ver a URL redirecttarget especificada para un fluxo de autenticación de terceiros. Cando isto se complete, a aplicación de terceiros enviará ó navegador web ou visor web a esta URL. Vostede debe eliminar calquera consulta ou parámetros POST da URL e pasalos como unha consulta logincontinue a este módulo API.
- logincontinue
Esta petición é unha continucación despois dun resposta precedente UI ou REDIRECT. Esta ou loginreturnurl é requirida.
- Tipo: booleano (detalles)
- logintoken
Un identificador "login" recuperado por action=query&meta=tokens
- Este parámetro é obrigatorio.
- *
- Este módulo acepta parámetros adicionais dependendo das consultas de autenticación dispoñibles. Use action=query&meta=authmanagerinfo con amirequestsfor=login (ou unha resposta previa deste módulo, se aplicable) para determinar as consultas dispoñibles e os campos que usan.
- Comezar o proceso de conexión á wiki como o usuario Exemplo con contrasinal ExemploContrasinal.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [abrir na zona de probas]
- Continuar a conexión despois dunha resposta de UI para unha autenticación de dous factores, proporcionando un OATHToken con valor 987654.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [abrir na zona de probas]