Nápověda k MediaWiki API

Toto je automaticky generovaná dokumentační stránka k MediaWiki API.

Dokumentace a příklady: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)

Tento modul vyžaduje oprávnění k zápisu.
Tento modul přijímá pouze požadavky POST.
Zdroj: MediaWiki
Licence: GPL-2.0-or-later

Prihlásiť sa na wiki pomocou interaktívneho postupu.

Všeobecný postup použitia tohto modulu je:

Získajte dostupné polia z action=query&meta=authmanagerinfo s amirequestsfor=login a token login z action=query&meta=tokens.
Zobrazte polia používateľovi a získajte ich odoslanie.
Pošlite POST do tohto modulu so zadaním loginreturnurl a všetkých relevantných polí.
Skontrolujte status v odpovedi.
- Ak ste dostali PASS alebo FAIL, ste hotoví. Operácia buď uspela, alebo nie.
- Ak ste dostali UI, zobrazte nové polia používateľovi a získajte ich odoslanie. Potom pošlite POST do tohto modulu s logincontinue a nastavenými relevantnými poľami a opakujte krok 4.
- Ak ste dostali REDIRECT, presmerujte používateľa na redirecttarget a počkajte na návrat na loginreturnurl. Potom pošlite POST do tohto modulu s logincontinue a všetkými poľami odovzdanými návratovej URL a opakujte krok 4.
- Ak ste dostali RESTART, znamená to, že autentifikácia fungovala, ale nemáme prepojený používateľský účet. Môžete to považovať za UI alebo za FAIL.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login

Parametry:

K dispozícii sú aj ďalšie všeobecné parametre.

loginrequests

Použiť iba tieto autentifikačné požiadavky, podľa id vráteného z action=query&meta=authmanagerinfo s amirequestsfor=login alebo z predchádzajúcej odpovede tohto modulu.

Hodnoty oddělujte pomocí | nebo alternativou.

Maximálny počet hodnôt je 50 (500 pre klientov s povolenými vyššími limitmi).

loginmessageformat

Formát, ktorý sa má použiť na vracanie správ.

Jedna z následujících hodnot: html, none, raw, wikitext

Predvolené: wikitext

loginmergerequestfields

Zlúčiť informácie o poliach všetkých autentifikačných požiadaviek do jedného poľa.

Typ: logická hodnota (boolean) (podrobnosti)

loginpreservestate

Zachovať stav z predchádzajúceho neúspešného pokusu o prihlásenie, ak je to možné.

Typ: logická hodnota (boolean) (podrobnosti)

loginreturnurl

Návratová URL pre autentifikačné postupy tretích strán, musí byť absolútna. Vyžaduje sa buď táto, alebo logincontinue.

Po prijatí odpovede REDIRECT zvyčajne otvoríte prehliadač alebo webové zobrazenie na zadanej URL redirecttarget pre autentifikačný postup tretej strany. Po jeho dokončení tretia strana pošle prehliadač alebo webové zobrazenie na túto URL. Mali by ste z URL extrahovať všetky parametre dotazu alebo POST a odovzdať ich ako požiadavku logincontinue tomuto modulu API.

logincontinue

Táto požiadavka je pokračovaním po skoršej odpovedi UI alebo REDIRECT. Vyžaduje sa buď táto, alebo loginreturnurl.

Typ: logická hodnota (boolean) (podrobnosti)

logintoken

Token typu „login“ získaný pomocí action=query&meta=tokens.

Tento parameter je povinný.

*

Tento modul prijíma dodatočné parametre v závislosti od dostupných autentifikačných požiadaviek. Na zistenie dostupných požiadaviek a polí, ktoré používajú, použite action=query&meta=authmanagerinfo s amirequestsfor=login (alebo prípadne predchádzajúcu odpoveď tohto modulu).

Příklady:

Začať proces prihlasovania na wiki ako používateľ Example s heslom ExamplePassword.: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [otevřít v pískovišti]
Pokračovať v prihlasovaní po odpovedi UI pre dvojfaktorové overenie, so zadaním OATHToken s hodnotou 987654.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [otevřít v pískovišti]