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

From EVE University Wiki
Jump to: navigation, search
(Making an outline.)
Line 7: Line 7:
 
* Try to provide code examples/applications for each endpoint.
 
* Try to provide code examples/applications for each endpoint.
  
=CREST=
+
=Introduction=
  
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 with the level of access we currently have, it is quite useful.
+
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.
 +
 
 +
==Resources==
 +
 
 +
{{ important note box | As of Dec. 2014, no publicly released CREST endpoints support the modification or deletion of resources.}}
 +
 
 +
CCP exposes various things in EVE Online as ''resources'', each of which have a canonical URI (Uniform Resource Identifier). CREST allows third-party developers to obtain (and read) representations of these resources by making an appropriate HTTP GET request to the resource's URI. Resources can be appended (written to), by making an appropriate HTTP PUT request, and deleted by making a correct HTTP DELETE request to the resource's URI.
 +
 
 +
All resources can be reached from the root API entry point URI, which will be shortened to ''entry point'' from here forward. Entry points will be discussed more in-depth later, in their own section.
 +
 
 +
==Representations==
 +
 
 +
 
 +
=Usage=
 +
 
 +
==Entry Points==
 +
 
 +
==Endpoints===
 +
 
 +
===Market===
 +
 
 +
===Industry===
 +
 
 +
=External Resources=

Revision as of 03:09, 2 December 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.

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.

Resources

As of Dec. 2014, no publicly released CREST endpoints support the modification or deletion of resources.

CCP exposes various things in EVE Online as resources, each of which have a canonical URI (Uniform Resource Identifier). CREST allows third-party developers to obtain (and read) representations of these resources by making an appropriate HTTP GET request to the resource's URI. Resources can be appended (written to), by making an appropriate HTTP PUT request, and deleted by making a correct HTTP DELETE request to the resource's URI.

All resources can be reached from the root API entry point URI, which will be shortened to entry point from here forward. Entry points will be discussed more in-depth later, in their own section.

Representations

Usage

Entry Points

Endpoints=

Market

Industry

External Resources