مساعدة API ميدياويكي

هذه صفحة توثيق ميدياويكي API التي تم إنشاؤها تلقائيا.

وثائق وأمثلة: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=clientlogin (login)

(main | clientlogin)
  • هذه الوحدة تتطلب صلاحيات الكتابة.
  • هذه الوحدة تقبل طلبات POST فقط.
  • المصدر:MediaWiki
  • الترخيص: GPL-2.0-or-later

تسجيل الدخول إلى ويكي باستخدام التدفق التفاعلي.

الإجراء العام لاستخدام هذه الوحدة هو:

  1. جلب الحقول المتاحة من action=query&meta=authmanagerinfo مع amirequestsfor=login، $amirequestsfor=login ورمز login من action=query&meta=tokens.

عرض الحقول للمستخدم، والحصول على تقديمها.

  1. النشر في هذه الوحدة، مع توفير loginreturnurl وأية حقول ذات صلة.
  2. افحص status في الاستجابة.
    • إذا تلقيت PASS أو FAIL أنت انتهيت، العملية نجحت أو لم تفعل.
    • إذا تلقيت UI، قدم الحقول الجديدة للمستخدم والحصول على تقديمها، ثم انشر في هذه الوحدة باستخدام logincontinue والحقول ذات الصلة المحددة، وكرر الخطوة 4.
    • إذا تلقيت REDIRECT، وجه المستخدم إلى redirecttarget وانتظر العودة إلى loginreturnurl، ثم انشر في هذه الوحدة باستخدام logincontinue وأية حقول تم تمريرها إلى المسار للعودة ، وكرر الخطوة 4.
    • إذا تلقيت RESTART، هذا يعني أن المصادقة ناجحة ولكن ليس لدينا حساب مستخدم مرتبط، قد تعامل هذا كـUI أو كـFAIL.
وسائط:
Other general parameters are available.
loginrequests

استخدم فقط طلبات المصادقة هذه، بواسطة id الذي يتم إرجاعه من action=query&meta=authmanagerinfo with amirequestsfor=login أو من رد سابق من هذه الوحدة.

قيم منفصلة بـ| أو بديل.
الحد الأقصى لعدد القيم هو 50 ( 500 للعملاء المسموح لهم بحدود أعلى).
loginmessageformat

تنسيق لاستخدامه في إرسال الرسائل.

إحدى القيم التالية: html، none، raw، wikitext
الافتراضي: wikitext
loginmergerequestfields

دمج معلومات الحقل لجميع طلبات التوثيق في مصفوفة واحدة.

Type: boolean (details)
loginpreservestate

الحفاظ على الحالة من محاولة تسجيل دخول فاشلة سابقة، إن أمكن.

Type: boolean (details)
loginreturnurl

يجب أن يكون العودة لتدفقات المصادقة من الجهات الخارجية مطلقا، مطلوب إما هذا أو logincontinue.

عند استلام استجابة REDIRECT، ستفتح عادةً متصفح أو عرض ويب للمسار redirecttargetالمحدد لتدفق مصادقة طرف ثالث، عند اكتمال ذلك، سيرسل الطرف الثالث المتصفح أو عرض الويب إلى هذا المسار، يجب عليك استخلاص أي استعلام أو وسائط POST من المسار وتمريرها كطلب logincontinue إلى وحدة API هذه.

logincontinue

هذا الطلب استمرار بعد استجابة UI أو REDIRECT سابقة، مطلوب إما هذا أو loginreturnurl.

Type: boolean (details)
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 [فتح في ملعب]