Pomoč za API MediaWiki
To je samodejno ustvarjena stran za API MediaWiki.
Dokumentacija in zgledi: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=clientlogin (login)
- Ta modul zahteva pravice pisanja.
- Ta modul sprejema samo zahtevke POST.
- Vir: MediaWiki
- Licenca: GPL-2.0-or-later
Prijava v viki z uporabo interaktivnega toka.
Splošni postopek za uporabo tega modula je:
- Pridobite polja, ki so na voljo iz action=query&meta=authmanagerinfo z amirequestsfor= login in žeton login iz action=query&meta=tokens .
- Predstavite polja uporabniku in pridobite njegov odgovor.
- Objavite v tem modulu z navedbo loginreturnurl in vseh ustreznih polj.
- Preverite status v odgovoru.
- Če ste prejeli PASS ali FAIL, ste končali. Operacija je bila bodisi uspešna bodisi ne.
- Če ste prejeli UI, predstavite nova polja uporabniku in pridobite njegov odgovor. Nato objavite v tem modulu z logincontinue in nastavljenimi ustreznimi polji ter ponovite 4. korak.
- Če ste prejeli REDIRECT, usmerite uporabnika na cilj v polju reddirecttargtet in počakajte na vrnitev na loginreturnurl. Nato objavite v tem modulu z logincontinue in vsemi polji, posredovanimi povratnemu URL-ju, ter ponovite 4. korak.
- Če ste prejeli RESTART, to pomeni, da je preverjanje pristnosti delovalo, vendar nimamo povezanega uporabniškega računa. To lahko obravnavate kot UI ali kot FAIL.
- loginrequests
Uporabite samo te zahtevke za avtentikacijo z id, ki ga vrne action=query&meta=authmanagerinfo z amirequestsfor= login ali iz prejšnjega odgovora tega modula.
- Loči vrednosti z | ali alternative.
- Največje število vrednosti je 50 (500 za odjemalce z večjimi dovoljenimi omejitvami)
- loginmessageformat
Oblikovanje za uporabo vrnjenih sporočl.
- Ena od naslednjih vrednosti: html, none, raw, wikitext
- Privzeto: wikitext
- loginmergerequestfields
Združitev informacij o poljih za vse avtentikacijske zahtevke v eno matriko.
- Tip: Boolov (podrobnosti)
- loginpreservestate
Če je mogoče, ohrani stanje prejšnjega neuspešnega poskusa prijave.
- Tip: Boolov (podrobnosti)
- loginreturnurl
URL za povratno povezavo za poteke avtentikacije tretjih oseb mora biti absoluten. Zahtevan je bodisi ta bodisi logincontinue .
Ko prejmete odgovor REDIRECT, boste običajno odprli brskalniški ali spletni pogled na določen URL redirecttarget za potek avtentikacije tretje osebe. Ko se to zaključi, bo tretja oseba poslala brskalniški ali spletni pogled na ta URL. Iz URL-ja morate izvleči vse parametre poizvedbe ali POST in jih kot zahtevek logincontinue posredovati temu API-modulu.
- logincontinue
Ta zahtevek je nadaljevanje prejšnjega odgovora UI/samp> ali REDIRECT. Zahtevan je bodisi ta bodisi loginreturnurl.
- Tip: Boolov (podrobnosti)
- logintoken
Žeton »login« pridobljen iz action=query&meta=tokens
- Ta parameter je obvezen.
- *
- Ta modul sprejema dodatne parametre, odvisno od razpoložljivih zahtevkov za avtentikacijo. Za določitev razpoložljivih zahtevkov in polj, ki jih uporabljajo, uporabite action=query&meta=authmanagerinfo z amirequestsfor= login (ali prejšnjim odgovorom iz tega modula, če je primerno).
- Začetek postopka prijave v viki kot uporabnik Example z geslom ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [odpri v peskovniku]
- Nadaljevanje prijave po odzivu UI za dvofaktorsko avtentikacijo in zagotovitev OATHToken z vrednostjo 987654.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [odpri v peskovniku]