Difference between revisions of "Mediawiki API"
| Line 3: | Line 3: | ||
=Process Flow= | =Process Flow= | ||
This process flow is to | This process flow is to document on how the front-end application can communicate with an instance of Mediawiki, which in this context PKC. | ||
==Login Process== | ==Login Process== | ||
Mediawiki API | Mediawiki API has two different scenarios for handling the login process. | ||
===1. Using Robot Account=== | ===1. Using Robot Account=== | ||
This scenario is to | This scenario is to accommodate automation process on behalf of specified user. To enable the process, you will need to prepare your bot account, which can be done by visiting [Special:BotPasswords], then you decide the bot name and Mediawiki will prepare the username and password that can be use to access the API. Please see the right image for reference. | ||
[[File:Bot-password.jpg|thumb|center|Bot Password setup on Mediawiki]] | [[File:Bot-password.jpg|thumb|center|Bot Password setup on Mediawiki]] | ||
'''First API to call''' | '''First API to call''' | ||
| Line 87: | Line 87: | ||
===2. Using Your Account=== | ===2. Using Your Account=== | ||
This scenario is to | This scenario is to accommodate a fully interactive process to Mediawiki, and position Mediawiki as the backend. | ||
==How to get one page according to page title== | |||
===1. Retrieving Page=== | ===1. Retrieving Page=== | ||
===2. Updating Page=== | ===2. Updating Page=== | ||
==Page | |||
=References= | =References= | ||
Revision as of 08:53, 13 October 2022
Introduction to Mediawiki API
API stands for Application Programmer Interface, is one way of communicating through a system using a standard way of communication between applications. API Services of this mediawiki can be found in | API Documentation.
Process Flow
This process flow is to document on how the front-end application can communicate with an instance of Mediawiki, which in this context PKC.
Login Process
Mediawiki API has two different scenarios for handling the login process.
1. Using Robot Account
This scenario is to accommodate automation process on behalf of specified user. To enable the process, you will need to prepare your bot account, which can be done by visiting [Special:BotPasswords], then you decide the bot name and Mediawiki will prepare the username and password that can be use to access the API. Please see the right image for reference.
First API to call Type: GET Endpoint: /api.php?
| key | value |
|---|---|
| action | query |
| meta | tokens |
| format | json |
| type | login |
Response:
{
"batchcomplete": "",
"query": {
"tokens": {
"logintoken": "ed965e6288be0ab007b8eab63637cca762eb3af1+\\"
}
}
}
Second API To Call Type: POST Endpoint: /api.php?
| key | value | location |
|---|---|---|
| action | login | parameter |
| format | json | parameter |
| lgname | [your-bot-username] | body |
| lgpassword | [your-bot-password] | body |
| lgtoken | {from prev API} | body |
Response
{
"login": {
"result": "Success",
"lguserid": 9,
"lgusername": "[your-bot-username]"
}
}
Please noted on token value, as a response result from first API, you will need to pass excludes the last '\' character.
examples response : ed965e6288be0ab007b8eab63637cca762eb3af1+\\ sending as : ed965e6288be0ab007b8eab63637cca762eb3af1+\
Once you have API login replied as success, you can start the transaction using the same login token that is sent on second API.
2. Using Your Account
This scenario is to accommodate a fully interactive process to Mediawiki, and position Mediawiki as the backend.
How to get one page according to page title
1. Retrieving Page
2. Updating Page
==Page