Difference between revisions of "WebAPI:Main"

From Starsonata Wiki
Jump to: navigation, search
Line 8: Line 8:
 
* [[WebAPI:teams|teams]]: Returns details on all the current Userteams.
 
* [[WebAPI:teams|teams]]: Returns details on all the current Userteams.
 
* [[WebAPI:server_status|server_status]]: Returns information about the current status of servers.
 
* [[WebAPI:server_status|server_status]]: Returns information about the current status of servers.
 +
 +
===Planned Endpoints===
 +
* '''items''' - an endpoint to retrieve the stats of "publicly known" items (items that have been on the public market at some point) is currently being developed.
 +
* An endpoint to retrieve market data for items.
 +
* An endpoint to retrieve basic details on past universes such as start/end times and final emperor details.
 +
* An endpoint showing bulletin board data.
 +
* Authenticated endpoints showing privileged information
 +
** Team data such as team skill data, members and their ranks, team ledger, and more.
 +
** Account data such as characters on the account.
 +
** Character data such as skills, owned assets, and more.
  
 
[[Category:WebAPI| Main]]
 
[[Category:WebAPI| Main]]

Revision as of 19:49, 14 June 2018

The Star Sonata 2 Web API is an interface that allows developers of third party programs or applications to retrieve data directly from the Star Sonata 2 servers in a secure manner.

Current endpoints are public information only and require no authentication. Authenticated requests are planned for the future to get detailed information on teams and individual character details.

Endpoints

  • galaxies: Returns information on galaxies in the current universe.
  • galaxies_recent: Returns information on recently changed galaxies (with a much lower cache time than galaxies).
  • teams: Returns details on all the current Userteams.
  • server_status: Returns information about the current status of servers.

Planned Endpoints

  • items - an endpoint to retrieve the stats of "publicly known" items (items that have been on the public market at some point) is currently being developed.
  • An endpoint to retrieve market data for items.
  • An endpoint to retrieve basic details on past universes such as start/end times and final emperor details.
  • An endpoint showing bulletin board data.
  • Authenticated endpoints showing privileged information
    • Team data such as team skill data, members and their ranks, team ledger, and more.
    • Account data such as characters on the account.
    • Character data such as skills, owned assets, and more.