Difference between revisions of "API"
m |
General Earl (talk | contribs) m |
||
| Line 2: | Line 2: | ||
==How to get an API key== | ==How to get an API key== | ||
| − | If you would like access to game feeds, you must request an API key from [[User:qzjul|qzjul]] or [[User:Pangaea|Pangaea]], in [[ | + | If you would like access to game feeds, you must request an API key from [[User:qzjul|qzjul]] or [[User:Pangaea|Pangaea]], in [[#earthempires]] ([[IRC]]), or on the Earth Empires [http://forums.earthempires.com/ forums]. |
==Usage== | ==Usage== | ||
Revision as of 21:14, 28 March 2011
An API key is used to access in-game news feeds such as ranks, news and market data. This information can then be used to create community-based sites similar to Boxcar or EEstats. There are many different sites that use this game data to benefit their alliance or the community in general.
How to get an API key
If you would like access to game feeds, you must request an API key from qzjul or Pangaea, in #earthempires (IRC), or on the Earth Empires forums.
Usage
Once you have an API key, the data is fairly easy to acquire. A simple HTTP request can be used to access this data which is sent in a CSV format. It is then up to the developer's discretion as to how to parse and display the data for human consumption.
Request Format
Once you have a key, you will be granted permission to a forum which is dedicated to helping and answering developers' questions. All updates concerning the API and it's use are noted here. Developers should check this often. There are many examples of how to properly use the API. it is highly recommended you learn about .gzip compression with the use of your platform to help EE conserve bandwidth.
