Difference between revisions of "User:Drakken Keisterbane/CREST"

From EVE University Wiki
Jump to: navigation, search
(Created page with "{{WIP}} =CREST=")
 
(More work. Added entry points and endpoints.)
Line 1: Line 1:
 
{{WIP}}
 
{{WIP}}
 +
 +
{{wip}}
 +
 +
=TODO=
 +
 +
* Explain each endpoint in detail.
 +
* Polish explanation on API usage.
 +
* Try to provide code examples/applications for each endpoint.
  
 
=CREST=
 
=CREST=
 +
 +
Carbon REST, or CREST, is a RESTful HTTP API that was created to allow developers read and write access to parts of the Eve Online universe. As of the writing of this article, it allows access to some public information about New Eden. Even the access we have now, however, is quite useful for many applications in game.
 +
 +
==Usage==
 +
 +
In general, you make a GET request to the target URL for the server that you wish to get information for, along with an endpoint which specifies what information you actually want. You then sift through the result that you get back to grab the information you want, assuming that you made the request correctly.
 +
 +
A correct response will return JSON code similar to the code below.
 +
[[http://pastebin.com/2bZym9qc This]] particular example is similar to result code you would get if you made a GET request to get some market data on some item.
 +
 +
An incorrectly formatted request will usually yield a 404 - Resource Not Found or similar error.
 +
 +
 +
 +
Entry point URLs and endpoints can be found below.
 +
 +
==Entry Points & Endpoints==
 +
 +
The entry point URL for GET requests to the Tranquility server (TQ), the one which we all use, is:
 +
 +
 +
{{code | http://public-crest.eveonline.com}}
 +
 +
 +
The entry point URL for GET requests to the Singularity server (Sisi), the test server, is:
 +
 +
 +
{{code | http://public-crest.sisi.testeveonline.com}}
 +
 +
 +
 +
The CREST API has seven endpoints that can be used to obtain data on various aspects of the game. These are listed below, along with instructions for use and possible applications:
 +
 +
===Tournaments===
 +
 +
'''Endpoint''': /tournaments/
 +
 +
'''Possible Applications''': TODO
 +
 +
===Districts===
 +
 +
'''Endpoint''': /districts/
 +
 +
'''Possible Applications''': TODO
 +
 +
===Killmails===
 +
 +
'''Endpoint''': /killmails/<kill_id>/<hash>
 +
 +
'''Possible Application''': TODO
 +
 +
===Incursions===
 +
 +
'''Endpoint''': /incursions/
 +
 +
'''Possible Applications''': TODO
 +
 +
===Alliances===
 +
 +
'''Endpoint(s)''': /alliances/ and /alliances/<alliance_id>
 +
 +
'''Possible Applications''': TODO
 +
 +
===Market===
 +
 +
'''Endpoint''': /market/<region_id>/types/<type_id>/history/
 +
 +
'''Possible Applications''': TODO

Revision as of 05:33, 17 March 2014

This page is a work in progress.

This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well.
If this article or section has not been edited in several days, please remove this template.

Template:Wip

TODO

  • Explain each endpoint in detail.
  • Polish explanation on API usage.
  • Try to provide code examples/applications for each endpoint.

CREST

Carbon REST, or CREST, is a RESTful HTTP API that was created to allow developers read and write access to parts of the Eve Online universe. As of the writing of this article, it allows access to some public information about New Eden. Even the access we have now, however, is quite useful for many applications in game.

Usage

In general, you make a GET request to the target URL for the server that you wish to get information for, along with an endpoint which specifies what information you actually want. You then sift through the result that you get back to grab the information you want, assuming that you made the request correctly.

A correct response will return JSON code similar to the code below. [This] particular example is similar to result code you would get if you made a GET request to get some market data on some item.

An incorrectly formatted request will usually yield a 404 - Resource Not Found or similar error.


Entry point URLs and endpoints can be found below.

Entry Points & Endpoints

The entry point URL for GET requests to the Tranquility server (TQ), the one which we all use, is:


http://public-crest.eveonline.com


The entry point URL for GET requests to the Singularity server (Sisi), the test server, is:


http://public-crest.sisi.testeveonline.com


The CREST API has seven endpoints that can be used to obtain data on various aspects of the game. These are listed below, along with instructions for use and possible applications:

Tournaments

Endpoint: /tournaments/

Possible Applications: TODO

Districts

Endpoint: /districts/

Possible Applications: TODO

Killmails

Endpoint: /killmails/<kill_id>/<hash>

Possible Application: TODO

Incursions

Endpoint: /incursions/

Possible Applications: TODO

Alliances

Endpoint(s): /alliances/ and /alliances/<alliance_id>

Possible Applications: TODO

Market

Endpoint: /market/<region_id>/types/<type_id>/history/

Possible Applications: TODO

Retrieved from "https://wiki.eveuniversity.org/index.php?title=User:Drakken_Keisterbane/CREST&oldid=66541"