Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

User:Drakken Keisterbane/CREST: Difference between revisions

From EVE University Wiki
Alliance endpoints done.
mNo edit summary
Line 1: Line 1:
{{WIP}}
{{WIP}}
=TODO=
* Explain each endpoint in detail.
* Polish explanation on API usage.
* Try to provide code examples/applications for each endpoint.
=Introduction=


The Carbon RESTful (CREST) HTTP API is a ''read and write'' API to the EVE Universe. It gives the ability to interact with the game cluster in an effective manner from clients and applications other than the EVE game client. Although not all CREST endpoints been released yet, there are plenty of useful public endpoints available at this time, with more being released on a regular basis.
The Carbon RESTful (CREST) HTTP API is a ''read and write'' API to the EVE Universe. It gives the ability to interact with the game cluster in an effective manner from clients and applications other than the EVE game client. Although not all CREST endpoints been released yet, there are plenty of useful public endpoints available at this time, with more being released on a regular basis.
Line 77: Line 69:


===Notes===
===Notes===
====Collections====


Many of the endpoints available on CREST will give an overview of an entire set of related resources. For example, the ''alliance'' endpoint, with no specification to a particular alliance, will give an overview of all alliances in EVE Online. For the purposes of this guide, we will call these types of endpoints '''collections'''.
Many of the endpoints available on CREST will give an overview of an entire set of related resources. For example, the ''alliance'' endpoint, with no specification to a particular alliance, will give an overview of all alliances in EVE Online. For the purposes of this guide, we will call these types of endpoints '''collections'''.
Line 85: Line 79:


In addition, each page will always have a '''next''' JSON object, which will contain a name/value pair, named '''href''' whose value is a URI that can be used to reach the next page of data in the collection.
In addition, each page will always have a '''next''' JSON object, which will contain a name/value pair, named '''href''' whose value is a URI that can be used to reach the next page of data in the collection.
====Common Object Structures====
(todo: fill this in with common object structures to reduce how many times things need to be written down)


===Alliances and Corporations===
===Alliances and Corporations===
====Alliance Info (all)====


<br />'''URI''': http://public-crest.eveonline.com/alliances/
<br />'''URI''': http://public-crest.eveonline.com/alliances/
Line 106: Line 106:
* '''pageCount_str''': A JSON string, which indicates the total number of pages in this collection.
* '''pageCount_str''': A JSON string, which indicates the total number of pages in this collection.


====Alliance Info (single)====


<br />'''URI''': http://public-crest.eveonline.com/alliances/<allianceid:integerType>/
<br />'''URI''': http://public-crest.eveonline.com/alliances/<allianceid:integerType>/