EVE API Guide: Difference between revisions

(19 intermediate revisions by 11 users not shown)

Line 1:

[[~~Category:Guides~~]]

[[~~Category~~:~~Software~~]]

{{hatnote|For uptodate information of the EVE API look [http://wiki.eve-id.net/APIv2_Page_Index here] [https://neweden-dev.com/Main_Page or here]}}

{{hatnote|CCPs new developer site can be found [https://developers.eveonline.com/ here]}}

This is a quick guide to using the EVE API in your own applications, scripts, and utilities.

Line 17:

Line 18:

=== Security ===

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.

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 [https://community.eveonline.com/support/api-key/ 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].

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

== API Functions ==

~~The available API functions are documented at http://wiki.eveonline.com/en/wiki/EVE_API_Functions~~

You may also find http://wiki.eve-id.net/APIv2_Page_Index to be a useful third-party reference.

== Using the API - Simple Examples ==

=== In Browser ===

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

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

https://api.eveonline.com/account/characters.xml.aspx?keyID=XXXXXX&vCode=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

That will return something like this.

<row name="YourCharactersName" characterID="YourCharactersID" corporationName="EVE University"

corporationID="CorporationID"/>

</rowset>

</result>

</eveapi>

Now if you want to access 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

This will return a big list, that looks like this.

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

rawQuantity="-1">

</rowset>

</row>

itemID is a general ID, and it can change in time i.e if items are packaged. TypeID is a unique identifier of the kind of item.

=== PHP ===

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.

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 [https://sourceforge.net/projects/eve-apiphp/ Ale] - make sure you have downloaded this and placed a copy on your webserver.

=== C# ===

=== Visual Basic ===

Get [http://wiki.eve-id.net/EveAI#Downloads EveAI.Live] from here

=== Visual Basic.NET ===

Get [http://wiki.eve-id.net/EveAI#Downloads EveAI.Live] from here

=== Python ===

Get [https://github.com/ntt/eveapi EveApi] from here. The [https://github.com/ntt/eveapi/blob/master/apitest.py apitest] file also serves as quite comprehensive documentation on how to use the library. This library is open source and available under the [https://en.wikipedia.org/wiki/MIT_License MIT License].

== Something A Bit More Complicated ==

== Sites of Interest ==

http://wiki.eve-id.net

[[Category:API]]

@@ Line 1: / Line 1: @@
-[[Category:Guides]]
+{{Deprecated|[[EVE Swagger Interface]]}}
-[[Category:Software]]
+{{hatnote|For uptodate information of the EVE API look [http://wiki.eve-id.net/APIv2_Page_Index here] [https://neweden-dev.com/Main_Page or here]}}
+{{hatnote|CCPs new developer site can be found [https://developers.eveonline.com/ here]}}
 This is a quick guide to using the EVE API in your own applications, scripts, and utilities.
@@ Line 17: / Line 18: @@
 === Security ===
-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.
+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 [https://community.eveonline.com/support/api-key/ 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].
+Note that at time of writing, a new API Key system allowing more granular access permissions was in development, and is discussed [https://www.eveonline.com/devblog.asp?a=blog&bid=912 here].
 == API Functions ==
-The available API functions are documented at http://wiki.eveonline.com/en/wiki/EVE_API_Functions
 You may also find http://wiki.eve-id.net/APIv2_Page_Index to be a useful third-party reference.
 == Using the API - Simple Examples ==
+=== In Browser ===
+They way to access your account or character information using a web browser, is with the API URLs. CCP is changing the API Keys access format, so the new way to access is as follows. (This will show you how to access, but not how to use it at the moment)
+You will need first an API Key with the proper access mask, it depends on what information you want to access to. For example, to access your Account Information use the next URL (Copy and paste, change the XXXXX fields with your information). You need the keyID and vCode.
+ https://api.eveonline.com/account/characters.xml.aspx?keyID=XXXXXX&vCode=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+That will return something like this.
+ <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 access 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
+This will return a big list, that looks like this.
+ <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>
+itemID is a general ID, and it can change in time i.e if items are packaged. TypeID is a unique identifier of the kind of item.
 === PHP ===
-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.
+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 [https://sourceforge.net/projects/eve-apiphp/ Ale] - make sure you have downloaded this and placed a copy on your webserver.
 === C# ===
-=== Visual Basic ===
+Get [http://wiki.eve-id.net/EveAI#Downloads EveAI.Live] from here
+=== Visual Basic.NET ===
+Get [http://wiki.eve-id.net/EveAI#Downloads EveAI.Live] from here
+=== Python ===
+Get [https://github.com/ntt/eveapi EveApi] from here. The [https://github.com/ntt/eveapi/blob/master/apitest.py apitest] file also serves as quite comprehensive documentation on how to use the library. This library is open source and available under the [https://en.wikipedia.org/wiki/MIT_License MIT License].
+== Something A Bit More Complicated ==
+== Sites of Interest ==
+http://wiki.eve-id.net
+[[Category:API]]