Difference between revisions of "WebAPI:Main"
From Starsonata Wiki
(→Endpoints) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
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. | 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=== | ===Endpoints=== | ||
| + | The root url for all current endpoints is <code>https://www.starsonata.com/webapi/</code>. | ||
* [[WebAPI:galaxies|galaxies]]: Returns information on galaxies in the current universe. | * [[WebAPI:galaxies|galaxies]]: Returns information on galaxies in the current universe. | ||
* [[WebAPI:galaxies_recent|galaxies_recent]]: Returns information on recently changed galaxies (with a much lower cache time than galaxies). | * [[WebAPI:galaxies_recent|galaxies_recent]]: Returns information on recently changed galaxies (with a much lower cache time than galaxies). | ||
* [[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]] | ||
Latest revision as of 17:59, 9 November 2019
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
The root url for all current endpoints is https://www.starsonata.com/webapi/.
- 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.
