Logging in to third-party tools

From Gamepedia Help Wiki
Jump to: navigation, search

With the change to our login system, access to wikis via external applications such as AutoWikiBrowser or pywikibot has changed as well.

Your regular web account credentials can now only be used to log in via the web interface. They cannot be used to log in via external tools or scripts.

Changes[edit | edit source]

In order to use bots or other external tools or scripts, a special set of login credentials needs to be generated first. This is done by logging in via the account where your bot edits come from, and then navigating to Special:BotPasswords, which is accessible at any Gamepedia wiki. Once the new bot login credentials are generated at a wiki, they are global to all other Gamepedia wikis as well.

Also, bot logins are now only accepted via HTTPS. Bot logins from HTTP will be rejected.

Bot logins can only access the MediaWiki API, not the normal web wiki interface.

This new system has several benefits:

  • A bot login grants access to the MediaWiki API without having to enter your account's main login credentials in a bot script/app.
  • Users can restrict their bot logins' editing permissions.
  • A single user can create multiple bot login credentials (for separate scripts, apps, etc), each with its own custom set of editing permissions.
  • If a user's bot credentials are ever lost or compromised, the user can easily revoke them, without having to change their main account password.

What does this mean for me?[edit | edit source]

If you use a third-party tool for editing wikis, you will now need to generate new credentials via Special:BotPasswords while logged in from the account that does your bot editing.

  • NOTE: This process is not exclusive to accounts that are flagged as bots. Any account that logs in via a third-party tool will need to follow this process.

Using Special:BotPasswords[edit | edit source]

Recommended Permissions
High-volume editing
Edit existing pages
Create, edit, and move pages
The above should be sufficient for most bots. The "Usage restrictions" field at the bottom doesn't usually need to be modified.
  1. Log in to a Gamepedia wiki via the regular web interface, using the account where you want your bot edits to show up. Users with separate accounts for web editing and bot editing should log in via their bot account, rather than the one they use for normal web editing.
  2. Navigate to Special:BotPasswords on any Gamepedia wiki.
  3. Fill in a "Bot name". For example: "MyRobot". This name will be added as a suffix to your currently logged-in username, for example: [email protected]
  4. Select the desired permissions for this bot login (see recommendations in the table to the right).
    • Note: You can only successfully grant permissions that your web account already has. For example, attempting to grant the "delete pages" permission and then using these bot credentials to edit a wiki where your web account is not an administrator or above will not actually grant your bot the ability to delete pages at that wiki.
  5. Click "Create".
  6. The bot username and generated password are displayed. This password will only be displayed on this page. Once you navigate away from this page, the password will not be retrievable.

Using your newly-created bot credentials[edit | edit source]

NOTE:
Prof hydra.svg Configure your external script or app to log in using the secure HTTPS protocol.
Bot logins from HTTP will be rejected!

Enter the credentials you just generated via the steps above (instead of your main account credentials), and set your tool to log in via HTTPS.

Edits with these bot credentials will show up as coming from the parent username that created the bot login. For example, an edit made by [email protected] will show up in the Contributions of ExampleUser, and will display in Recent Changes, page histories, etc as edits made by ExampleUser.

Managing an existing bot password[edit | edit source]

To manage an existing bot login, go to Special:BotPasswords on any Gamepedia wiki, and select a bot name.

  • To reset the bot login password, select "Reset the password" and click "Update".
  • To change the bot login's permissions, select or deselect the appropriate permissions in the displayed list and click "Update".
  • To delete the bot password, click "Delete".

See also[edit | edit source]