EVE API Guide: Difference between revisions

[[Category:Guides]]

[[Category:Software]]

{{Work_in_Progress}}

In order to prevent unauthorised access to private character/corporation data, the API uses an ''API Key''.  This is a randomly-generated string that essentially works as a password for API calls.  Account owners generate their own API keys through [http://www.eveonline.com/api/ this page].  That page also informs you of your unique numeric user ID, which is used in API calls instead of your username.  This allows a degree of trust with third-party applications, in that they neither need to know your login name or password.

Note that at time of writing, a new API Key system allowing more granular access permissions was in development, and is discussed [http://www.eveonline.com/devblog.asp?a=blog&bid=912 here].

They way to acces your account or character information using a web brower, is with the API URLs. CCP is changing the API Keys acces format, so the new way to acces is as follows. (This will show you how to acces, but not how to use it atm)

You will need first an API Key with the proper acces mask, it depends on what information you want to acces to. For example, to acces your Account Information use the next URL (Copy and paste, change the XXXXX fields with your information). You need the keyID and vCode.

<eveapi version="2">

<currentTime>2012-03-20 20:21:17</currentTime>

<result>

<rowset name="characters" key="characterID" columns="name,characterID,corporationName,corporationID">

<row name="YourCharactersName" characterID="YourCharactersID" corporationName="EVE University" corporationID="CorporationID"/>

</rowset>

</result>

<cachedUntil>2012-03-20 21:18:17</cachedUntil>

</eveapi>

Now if you want to acces to you Assets List, then use the follow URL.You can get your characterID using the previous example.

https://api.eveonline.com/char/AssetList.xml.aspx?keyID=XXXXXX&vCode=XXXXXXXXXXXXXXXXXXX&characterID=XXXXXXX

<eveapi version="2">

<currentTime>2012-03-20 20:39:17</currentTime>

<result>

<rowset name="assets" key="itemID" columns="itemID,locationID,typeID,quantity,flag,singleton">

<row itemID="1005838069096" locationID="60003493" typeID="34" quantity="1" flag="4" singleton="0"/>

<row itemID="1005922778803" locationID="60004279" typeID="606" quantity="1" flag="4" singleton="1" rawQuantity="-1">

<rowset name="contents" key="itemID" columns="itemID,typeID,quantity,flag,singleton">

<row itemID="1005922778804" typeID="3640" quantity="1" flag="27" singleton="1" rawQuantity="-1"/>

<row itemID="1005922778805" typeID="3651" quantity="1" flag="28" singleton="1" rawQuantity="-1"/>

<row itemID="1005922778806" typeID="34" quantity="1" flag="5" singleton="0"/>

</rowset>

</row>

A number of third-party libraries are available for PHP programmers, which will do the bulk of the work for you.  For the purposes of these examples, we will be using [http://sourceforge.net/projects/eve-apiphp/ Ale] - make sure you have downloaded this and placed a copy on your webserver.