RTGame:Application programming interface: Difference between revisions

API usage on the RTGame Wiki
No edit summary
Tag: 2017 source edit
No edit summary
Tag: 2017 source edit
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Shortcut|RT:API}}
{{Shortcut|RT:API}}


'''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 [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.
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.


Line 15: Line 12:
|-
|-
|[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bdescription description]
|[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 [[RT:Short description|short description]] of the given pages.
|-
|-
|[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bpageimages pageimages]
|[https://wiki.rtgame.co.uk/api.php?action=help&modules=query%2Bpageimages pageimages]
Line 25: Line 22:




{{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.}}
{{credit_SC}}
 
{{Wiki navplate}}
{{Wiki navplate}}
{{Short description|API usage on the RTGame Wiki}}
{{Short description|API usage on the RTGame Wiki}}
[[Category:Policies]]
[[Category:Policies]]

Latest revision as of 12:38, 6 May 2021

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-SA 4.0 license.