User:Drakken Keisterbane/CREST: Difference between revisions

(4 intermediate revisions by 2 users not shown)

Line 1:

~~{{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.

Line 61:

Line 53:

Note that violation of the specified rate limits may result in an IP ban from CREST.

==Entry Points==

===Entry Points===

There are two root entry points available for CREST, one for '''Tranquility''' and one for the '''Singularity''' test server (Sisi). The entry points below are accurate as of the time of writing.

Line 74:

Line 66:

==~~Endpoints~~==

===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'''.

Line 85:

Line 77:

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)

==Endpoints==

===Alliances and Corporations===

====Alliance Info (all)====

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

Line 106:

Line 111:

* '''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>/

Line 154:

Line 161:

===Other===

====Killmail====

To obtain the required killmail hash for the killmail endpoint, you can use the formula below:

'''killmailHash''' = '''sha1(''victimCharacterID'' + ''attackerCharacterID'' + ''shipTypeID'' + ''killTime'')'''

'''Note''': All variables in this formula are ''strings'', and adding them in this way represents ''concatenation'', not addition of the ids as integers.

Where the following is true:

* '''victimCharacterID''': The character id of the victim, as a string.

* '''attackerCharacterID''': The character id of the attacker that got the final blow. If the attacker with the final blow is an NPC (characterID == 0), this is the string "None" instead.

* '''shipTypeID''': The type id of the victim's ship.

* '''killTime''': The time the kill occurred, as a 64-bit timestamp (read unix timestamp * 10,000,000).

=External Resources=

@@ Line 1: / Line 1: @@
-{{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.
@@ Line 61: / Line 53: @@
 Note that violation of the specified rate limits may result in an IP ban from CREST.
-==Entry Points==
+===Entry Points===
 There are two root entry points available for CREST, one for '''Tranquility''' and one for the '''Singularity''' test server (Sisi). The entry points below are accurate as of the time of writing.
@@ Line 74: / Line 66: @@
-==Endpoints==
+===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'''.
@@ Line 85: / Line 77: @@
 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)
+==Endpoints==
 ===Alliances and Corporations===
+====Alliance Info (all)====
 <br />'''URI''': http://public-crest.eveonline.com/alliances/
@@ Line 106: / Line 111: @@
 * '''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>/
@@ Line 154: / Line 161: @@
 ===Other===
+====Killmail====
+To obtain the required killmail hash for the killmail endpoint, you can use the formula below:
+'''killmailHash''' = '''sha1(''victimCharacterID'' + ''attackerCharacterID'' + ''shipTypeID'' + ''killTime'')'''
+'''Note''': All variables in this formula are ''strings'', and adding them in this way represents ''concatenation'', not addition of the ids as integers.
+Where the following is true:
+* '''victimCharacterID''': The character id of the victim, as a string.
+* '''attackerCharacterID''': The character id of the attacker that got the final blow. If the attacker with the final blow is an NPC (characterID == 0), this is the string "None" instead.
+* '''shipTypeID''': The type id of the victim's ship.
+* '''killTime''': The time the kill occurred, as a 64-bit timestamp (read unix timestamp * 10,000,000).
 =External Resources=