Want to contribute? Join the Discord and ask for the editor role.
RTGame:Application programming interface: Difference between revisions
API usage on the RTGame Wiki
m (1 revision imported) |
No edit summary Tag: 2017 source edit |
||
| Line 1: | Line 1: | ||
{{Shortcut| | {{Shortcut|RT:API}} | ||
'''Application programming interfaces''' ('''APIs''') are what developers, fansite operators, and bots use to retrieve information about the game and the wiki. | '''Application programming interfaces''' ('''APIs''') are what developers, fansite operators, and bots use to retrieve information about the game and the wiki. | ||
== Mediawiki Action API == | == Mediawiki Action API == | ||
The | The RTGame Wiki provides an action API that can be accessed [https://wiki.rtgame.co.uk/api.php here]. Additional documentation is available on the [https://www.mediawiki.org/wiki/API:Main_page Mediawiki Action API page]. Some features are limited to logged in users, administrators, and bureaucrats. The [[Special:ApiSandbox|API Sandbox]] special page may be useful for users new to creating requests. | ||
Below are a few useful modules under the [https:// | Below are a few useful modules under the [https://wiki.rtgame.co.uk/api.php?action=help&modules=query query action]: | ||
{| class="wikitable" | {| class="wikitable" | ||
!Module | !Module | ||
!Use | !Use | ||
|- | |- | ||
|[https:// | |[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bprefixsearch prefixsearch] | ||
|Take user input and return the best-matching titles. Should be used with generator. | |Take user input and return the best-matching titles. Should be used with generator. | ||
|- | |- | ||
|[https:// | |[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bdescription description] | ||
|Returns a [[SC:Short description|short description]] of the given pages. | |Returns a [[SC:Short description|short description]] of the given pages. | ||
|- | |- | ||
|[https:// | |[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bpageimages pageimages] | ||
|Returns information about images on the page, such as thumbnail and presence of photos. | |Returns information about images on the page, such as thumbnail and presence of photos. | ||
|- | |- | ||
|[https:// | |[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bextracts extracts] | ||
|Returns plain-text or limited HTML extracts of the given pages. | |Returns plain-text or limited HTML extracts of the given pages. | ||
|} | |} | ||
{{Note|'''Note:''' A portion of the text above is originated from the [https:// | {{Note|'''Note:''' A portion of the text above is originated from the [https://starcitizen.tools/ Star Citizen Wiki] under [https://creativecommons.org/licenses/by-nc-sa/3.0/ CC BY-NC-SA 4.0] license.}} | ||
{{Wiki navplate}} | {{Wiki navplate}} | ||
{{Short description|API usage on the | {{Short description|API usage on the RTGame Wiki}} | ||
[[Category:Policies]] | [[Category:Policies]] | ||
Revision as of 15:13, 4 May 2021
Application programming interfaces (APIs) are what developers, fansite operators, and bots use to retrieve information about the game and the wiki.
Mediawiki Action API
The RTGame Wiki provides an action API that can be accessed here. Additional documentation is available on the Mediawiki Action API page. Some features are limited to logged in users, administrators, and bureaucrats. The API Sandbox special page may be useful for users new to creating requests.
Below are a few useful modules under the query action:
| Module | Use |
|---|---|
| prefixsearch | Take user input and return the best-matching titles. Should be used with generator. |
| description | Returns a short description of the given pages. |
| pageimages | Returns information about images on the page, such as thumbnail and presence of photos. |
| extracts | Returns plain-text or limited HTML extracts of the given pages. |
Note: A portion of the text above is originated from the Star Citizen Wiki under CC BY-NC-SA 4.0 license.
| RTGame Wiki community | ||
|---|---|---|
| Projects | Search Engine Optimization • | |
| Policies | Application programming interface • Copyrights • Lua • Policies • Redirect • Short description • Shortcut • Style guide • Templates • | |
| Editing guides | Advanced editing • Cheat sheet • Source mode basics • VisualEditor advanced • VisualEditor basics • Your first edit • | |