GK Aion API details
Current version: 0.25 - See version history at the bottom of this page for more details.
One of our membes has developed a simple API to use for obtaining details about characters or legions from within Aion. The API, written in PhP, uses basic html-parsing to obtain all of the requested details from the Aion website. Details of it's use are below.
v0.25 - Substantial update to deal with extra data fields in the new HTML layout
Since the last time I played Aion, NCSoft have made substantial changes to the HTML layout of their character pages. This update to the Aion API corrects the errors that this introduced and adds new fields where they have been created. The new data now available is:
- Healing Boost
- Casting Speed
- Evade
- Crit Spell
- Crit Resist
- Crit Fortitude
- Spell Resist
- Spell Fortitude
v0.22 - Adding JSONP functionality
The latest version of the GK Aion API now supports the generation of JSONP. If you'd like to make use of this functionality, simply pass the name of the callback function you wish to use on the URL request as the parameter "callback". For example:
http://www.griffonknight.com/AionAPI/request.php?type=C&server=Telemachus&element=Greyshade&rtnType=J&callback=functionname
This will return the JSON encoded data wrapped in a call to the function "functionname".
AionRunnerSlim - Leveraging the GK Aion API
Zaephor of the Ariel server has built a cool little VB app which leverages the API to create a very small in-game search function. For more details have a look at this page.
Important points:
- The API is currently working fully (as far as i'm aware for the EU servers), it is in beta for US servers.
- If you have any questions or comments about the API, please visit our forums and post in the General Discussion board or you can contact me directly at gk_api@griffonknight.com.
- If you want to decode the JSON string returned you'll need to use assoc parameter to build the appropriate associative array.
Use of the API:
Using the following URL you can obtain information about an individual character or a legion within Aion:
http://www.griffonknight.com/AionAPI/request.php?type=<1>&server=<2>&element=<3>&rtnType=<4>
WHERE:
- "C" for Character request or "L" for Legion.
- Name of the server (eg. Telemachus)
- Name of character or legion (Note that the api will try to match a single entry for what you pass in here. If a single match is found it will return results, if not it will fail).
- Return information type: "X" for XML or "J" for a JSON encoded array.
An example in PHP:
You can see a more detailed example of how a very simple Legion Roster page can be generated using PHP and HTML here:
http://www.griffonknight.com/hostedfiles/AionAPIexample.php
Example data:
You can see detailed examples of the data returned by the API here:
http://www.griffonknight.com/hostedfiles/AionAPIexampleData.php
Using the mini-popup view:
If you would like to use an "in-game" version of the lookup tool you'll need to do the following:
- Download a tool that will allow you to set any window to "always on top" (I suggest this one: http://www.box.net/shared/4ej5cqoekj
- Open the main UI for the tool: http://www.griffonknight.com/AionAPI/
- Click the "Popup version" link in the top navigation bar
- Select the mini-popup window and use the control-key sequence to set it to "always on top"
- Launch Aion and make sure you have "Full screen windowed mode" selected.
- Now you should be able to have the popup open whilst you're playing and search for characters as you need to.
Version history:
- v0.22 - 19 June 2010 - Added JSONP functionality.
- v0.21 - 19 Feb 2010 - Fixed some bugs in the API that people have mailed me about.
More specifically:
- Stopped (hopefully) the problem of no Legion data being returned when more than one legion name matches the name searched for.
- Stopped problems with higher ranking characters failing to find PvP status info.
- Corrected the Nezekan server name / id in the server database.
- Fixed an issue that was causing enchanted gear to not show up correctly.
- Added legion name to extracted details when pulling out legion info. - v0.20 - 8 Feb 2010 - Region is no longer a required field for the submission of requests (any
region passed in will now be ignored).
- New interface screen with mini-popup window added: http://www.griffonknight.com/AionAPI/
- v0.11 - 26 Jan 2010 - Character request now extracts item level and manastone details.
- v0.10 - 21 Jan 2010 - Character request now extracts Equipment info.
- v0.09 - 09 Jan 2010 - Support for North American servers is now in place.