API:Assert

From mediawiki.org
This page is a translated version of the page API:Assert and the translation is 3% complete.
Outdated translations are marked like this.
เวอร์ชันมีเดียวิกิ:
1.23

The assert parameter of the Action API can be set on any API request to verify certain conditions before the requested action is executed.

The available options are:

  • assert=anon: Check that you are acting as an IP user . This prevents accidental use of a registered account. Since MW 1.35 Gerrit change 572374
  • assert=user: Check that you are using a registered account (either "named" or temporary). This prevents accidental fallback to an IP user.
  • assert=bot: ตรวจสอบว่าบัญชีของคุณมีสิทธิ์ "bot" อยู่แล้ว This prevents your script from interacting with wikis where your bot does not have the bot flag.
  • assertuser=...: Check that you are logged-in with the expected user name. Since MW 1.28

Note that temporary users satisfy assert=user, and fail assert=anon.

Possible errors

หากการยืนยันล้มเหลวรหัสข้อผิดพลาดของ $1 หรือ $2 จะถูกส่งคืน

  • assertanonfailed
  • assertuserfailed
  • assertbotfailed
  • assertnameduserfailed

Rationale and use cases

These parameters are intended as a second line of defense against several kinds of problems:

Bot operator errors

It's easy for a simple operator error to cause a lot of bad edits, such as the bot running on the wrong wiki or under the wrong username, especially if you're running more than one bot task. The assert=bot and assertuser=... parameters are intended to help prevent those mistakes.

Login session expiration

After logging in, the cookies you receive are only valid for 30 days by default, after which time your bot will become logged out, and may continue working with its actions being attributed to the IP address or a temporary username (if logged-out users are allowed to perform them).

The assert=user parameter is intended to prevent this.

Switching user accounts

Interactive tools (in the browser) using the API to edit often want to make sure the user understands how their work will be attributed.

When the user logs in or out in another browser tab (or their login session expires), this won't be immediately reflected in the tool's interface, but the new login session will be used for saving actions. The assertuser=... and assert=anon parameters are intended to allow detecting this scenario and displaying an appropriate message before continuing.


กำลังตรวจสอบว่าคุณเข้าสู่ระบบหรือไม่

หากคุณเพียงแค่ต้องการตรวจสอบว่าคุณได้ลงชื่อเข้าใช้ API การทำงานหรือไม่คุณสามารถส่งคำขอด้วยพารามิเตอร์ action=query&assert=user This will return an empty response ({} in the JSON format) if you are indeed logged in, or the assertuserfailed error if not.

โดยปกติคุณจะไม่ต้องทำเช่นนี้ Instead, set the assert=user parameter on each of your requests.