Difference between revisions of "PCGamingWiki:API"
From PCGamingWiki, the wiki about fixing PC games
m (updated page and included mention of MediaWiki API) |
m (minor changes) |
||
Line 2: | Line 2: | ||
===MediaWiki API=== | ===MediaWiki API=== | ||
− | {{ii}} As the PCGamingWiki is based on MediaWiki, the built-in [https://www.mediawiki.org/wiki/API:Main_page MediaWiki API] can be used to access a lot of data. MediaWiki extensions we use | + | {{ii}} As the PCGamingWiki is based on MediaWiki, the built-in [https://www.mediawiki.org/wiki/API:Main_page MediaWiki API] endpoint can be used to access a lot of data. Some MediaWiki extensions we use such as [https://www.semantic-mediawiki.org/wiki/Help:API Semantic MediaWiki] and [https://www.mediawiki.org/wiki/Extension:Cargo/Exporting_data#API Cargo] also exposes their own API actions through the MediaWiki API. |
− | + | {{++}} If you want to retrieve the Semanic MediaWiki properties (e.g. cover image, developer, publisher, release date, etc) of a page, the {{Code|browsebysubject}} API action is currently the most relevant one if you know the page name. See [https://www.pcgamingwiki.com/w/api.php?action=browsebysubject&format=json&subject=NieR%3A%20Automata this example] ([https://www.pcgamingwiki.com/wiki/Special:ApiSandbox#action=browsebysubject&format=json&subject=NieR%3A%20Automata sandbox]). | |
− | {{++}} If you want to retrieve the Semanic MediaWiki properties (e.g. cover image, developer, publisher, release date, etc) of a page, the {{Code|browsebysubject}} API action is currently the most relevant one if you know the page name. See [https://www.pcgamingwiki.com/w/api.php?action=browsebysubject&format=json&subject=NieR%3A%20Automata this example] ([https://www.pcgamingwiki.com/wiki/Special:ApiSandbox#action=browsebysubject&format=json&subject=NieR%3A%20Automata sandbox]) | + | {{mm}} The '''[[Special:ApiSandbox|API Sandbox]]''' can be helpful in figuring the API out. |
+ | {{ii}} '''Example (JSON)''' {{Pre|1=https://www.pcgamingwiki.com/w/api.php?action=browsebysubject&format=json&subject=NieR%3A%20Automata}} | ||
===Redirect API=== | ===Redirect API=== |
Revision as of 08:20, 8 April 2020
This page might not be updated to reflect all available API endpoints or functionality.
MediaWiki API
- As the PCGamingWiki is based on MediaWiki, the built-in MediaWiki API endpoint can be used to access a lot of data. Some MediaWiki extensions we use such as Semantic MediaWiki and Cargo also exposes their own API actions through the MediaWiki API.
- If you want to retrieve the Semanic MediaWiki properties (e.g. cover image, developer, publisher, release date, etc) of a page, the
browsebysubject
API action is currently the most relevant one if you know the page name. See this example (sandbox). - The API Sandbox can be helpful in figuring the API out.
- Example (JSON)
https://www.pcgamingwiki.com/w/api.php?action=browsebysubject&format=json&subject=NieR%3A%20Automata
Redirect API
- Our custom redirect API allows us to redirect incoming users using any Steam ID to the relevant PCGamingWiki page.
- Source code
- Example
https://pcgamingwiki.com/api/appid.php?appid=674020