עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)

היחידה הזאת דורשת הרשאות כתיבה.
יחידה זו מקבלת רק בקשות POST.
מקור: MediaWiki
רישיון: GPL-2.0-or-later

כניסה לוויקי באמצעות זרימה הידודית.

הנוהל הכללי לשימוש במודול הזה הוא:

אחזור השדות הזמינים מ־action=query&meta=authmanagerinfo עם amirequestsfor=login ואסימון login מתוך action=query&meta=tokens.
הצגת השדות למשתמש וקבלת אישור ממנו.
שליחה (Post) למודול הזה עם loginreturnurl וכל השדות הרלוונטיים.
בדיקת ה־status בתשובה.
- אם קיבלת PASS או FAIL, זה הסיום. הפעולה שלך הצליחה או נכשלה.
- אם קיבלת UI, יש להציג את השדות החדשים למשתמש ולקבל את מה שהוא ישלח. אחר־כך יש לשלוח (post) למודול הזה עם logincontinue ועם הגדרות של השדות הרלוונטיים ולחזור על צעד 4.
- אם קיבלת REDIRECT, יש להפנות את המשתמש ל־redirecttarget ולחכות לחזרה אל loginreturnurl. אחר־כך לשלוח (post) למודול הזה עם logincontinue ועם כל השדות שהועברו ל־URL שחוזרים אליו ולחזור על צעד 4.
- אם קיבלת RESTART, זה אומר שהאימות עבד אבל אין חשבון משתמש מקושר. באפשרותך לטפל בזה כמו ב־UI או ב־FAIL.

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

פרמטרים ייעודיים:

זמינים פרמטרים כלליים אחרים.

loginrequests

להשתמש רק בבקשות האימות האלו, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=login או מתשובה קודמת למודול הזה.

הפרדה בין ערכים נעשית באמצעות | או תו חלופי.

המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).

loginmessageformat

תסדיר לשימוש בהחזרת הודעות.

אחד מהערכים הבאים: html, none, raw, wikitext

ברירת המחדל: wikitext

loginmergerequestfields

מיזוג מידע של שדות עבור כל בקשות האימות למערך אחד.

סוג: בוליאני (פרטים)

loginpreservestate

שימור מצב מניסיון כניסה קודם, אם אפשר.

סוג: בוליאני (פרטים)

loginreturnurl

כתובת URL לחזרה עם זרימות אימות צד־שלישי, חייב להיות מוחלט. נדרש או זה או logincontinue.

עם קבלת תשובת REDIRECT, בדרך־כלל תפתח דפדפן או תצוגת וב בכתובת ה־redirecttarget שצוינה בשביל זרימת אימות צד־שלישי. כשזה יושלם, הצד השלישי ישלח את הדפדפן או את תצוגת הווב לכתובת הזאת. יש לחלץ את כל הפרמטרים של שאילתה או בקשת POST מה־URL ולהעביר אותם בתור בקשת logincontinue למודול ה־API הזה.

logincontinue

הבקשה הזאת היא המשך אחרי תשובת UI או REDIRECT קודמת. נדרש זה או loginreturnurl.

סוג: בוליאני (פרטים)

logintoken

אסימון "login" שאוחזר מ־action=query&meta=tokens

הפרמטר הזה נדרש.

*

המודול הזה מקבל פרמטרים נוספים בהתאם לבקשות אימות זמינות. יש להשתמש ב־action=query&meta=authmanagerinfo עם amirequestsfor=login (או תשובה קודמת מהמודול הזה, אם זה זמין) כדי להבין מה הבקשות הזמינות ובאילו שדות הן משתמשות.

דוגמאות:

תחילת תהליך כניסה לוויקי בתור משתמש Example עם הסיסמה ExamplePassword.: api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [פתיחה בארגז חול]
המשך כניסה אחרי תשובת UI לאימות דו־שלבי, עם OATHToken של 987654.: api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [פתיחה בארגז חול]