עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=createaccount (create)
- היחידה הזאת דורשת הרשאות כתיבה.
- יחידה זו מקבלת רק בקשות POST.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
יצירת חשבון משתמש חדש.
הנוהל הכללי לשימוש במודול הזה הוא:
- אחזור השדות הזמינים מ־action=query&meta=authmanagerinfo עם amirequestsfor=create ואסימון createaccount מתוך action=query&meta=tokens.
- הצגת השדות למשתמש וקבלת אישור ממנו.
- שליחה (Post) למודול הזה עם createreturnurl וכל השדות הרלוונטיים.
- בדיקת ה־status בתשובה.
- אם קיבלת PASS או FAIL, זה הסיום. הפעולה שלך הצליחה או נכשלה.
- אם קיבלת UI, יש להציג את השדות החדשים למשתמש ולקבל את מה שהוא ישלח. אחר־כך יש לשלוח (post) למודול הזה עם createcontinue ועם הגדרות של השדות הרלוונטיים ולחזור על צעד 4.
- אם קיבלת REDIRECT, יש להפנות את המשתמש ל־redirecttarget ולחכות לחזרה אל createreturnurl. אחר־כך לשלוח (post) למודול הזה עם createcontinue ועם כל השדות שהועברו ל־URL שחוזרים אליו ולחזור על צעד 4.
- אם קיבלת RESTART, זה אומר שהאימות עבד אבל אין חשבון משתמש מקושר. באפשרותך לטפל בזה כמו ב־UI או ב־FAIL.
- createrequests
להשתמש רק בבקשות האימות האלו, מאת id שהוחזר מ־action=query&meta=authmanagerinfo עם amirequestsfor=create או מתשובה קודמת למודול הזה.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- createmessageformat
תסדיר לשימוש בהחזרת הודעות.
- אחד מהערכים הבאים: html, none, raw, wikitext
- ברירת המחדל: wikitext
- createmergerequestfields
מיזוג מידע של שדות עבור כל בקשות האימות למערך אחד.
- סוג: בוליאני (פרטים)
- createpreservestate
שימור מצב מניסיון כניסה קודם, אם אפשר.
אם action=query&meta=authmanagerinfo החזיר true עבור hasprimarypreservedstate, בקשות שמסומנות בתור primary-required אמורות להיות מושמטות. אם מוחזר ערך לא ריק ל־preservedusername, שם המשתמש הזה ישמש לפרמטר username.
- סוג: בוליאני (פרטים)
- createreturnurl
כתובת URL לחזרה עם זרימות אימות צד־שלישי, חייב להיות מוחלט. נדרש או זה או createcontinue.
עם קבלת תשובת REDIRECT, בדרך־כלל תפתח דפדפן או תצוגת וב בכתובת ה־redirecttarget שצוינה בשביל זרימת אימות צד־שלישי. כשזה יושלם, הצד השלישי ישלח את הדפדפן או את תצוגת הווב לכתובת הזאת. יש לחלץ את כל הפרמטרים של שאילתה או בקשת POST מה־URL ולהעביר אותם בתור בקשת createcontinue למודול ה־API הזה.
- createcontinue
הבקשה הזאת היא המשך אחרי תשובת UI או REDIRECT קודמת. נדרש זה או createreturnurl.
- סוג: בוליאני (פרטים)
- createtoken
אסימון "createaccount" שאוחזר מ־action=query&meta=tokens
- הפרמטר הזה נדרש.
- *
- המודול הזה מקבל פרמטרים נוספים בהתאם לבקשות אימות זמינות. יש להשתמש ב־action=query&meta=authmanagerinfo עם amirequestsfor=create (או תשובה קודמת מהמודול הזה, אם זה זמין) כדי להבין מה הבקשות הזמינות ובאילו שדות הן משתמשות.
- תחילת תהליך יצירת המשתמש Example עם הסיסמה ExamplePassword.
- api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC [פתיחה בארגז חול]