User Tools
it:api_key
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
it:api_key [2019/01/03 20:28] Fof removed |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== API Key ====== | ||
| - | |||
| - | The EVE API is a webservice that allows out-of-game tools to request information about what is going on inside EVE. | ||
| - | |||
| - | There is a lot of public information that can be requested via the EVE API. Some examples are: | ||
| - | //How many players are currently logged into EVE?// //How many ships were killed in 6VDT during the last 24h?// //What corporations are members of TEST?// | ||
| - | |||
| - | However the API also allows to access information that is private to your own characters, such as: | ||
| - | //How many SP do I have and what am I currently training?// //Has my buy order been filled yet?// //Do I have any new eve-mails?// | ||
| - | |||
| - | If you are a corp director/CEO or have been assigned the appropriate roles you can also query corp-specific information: | ||
| - | //How much fuel is left in our POS?// //What ships did our corporation kill/lose recently?// //Where and in what ships are my corpmates currently?// | ||
| - | |||
| - | The API caches information that has recently been requested for different amounts of time (up to 24h, depending on the API call in question) - this can result in outdated information being returned by the API service. | ||
| - | |||
| - | Having a separate authentication system for the API (instead of just using your EVE username and password) allows you to share your API Key with other people (who can then access information about your characters) without you having to risk them stealing your EVE account. | ||
| - | |||
| - | ===== Creating Your API Key ===== | ||
| - | |||
| - | API keys can be created via CCP's API Key Management interface, its available [[https://community.eveonline.com/support/api-key/|here]] | ||
| - | |||
| - | Customizable API keys allow for you to assign permissions to specific API keys, limiting what a external application or person can see of your account. This is a massive change from the old system where you had two specific levels, Limited or Full, with some of the more general use private data (such as your recent kills) being only available with the Full key, which also allowed access to your full asset list. | ||
| - | |||
| - | ==== Key Types ==== | ||
| - | |||
| - | === Character Keys === | ||
| - | |||
| - | These types of keys are limited to specific character, this is useful if, for example, you wanted to give your API key to eveboard to sell that particular character, or allow someone on the character buy/sell forum to review the character in detail via their own tools before purchase. | ||
| - | |||
| - | === Account Keys === | ||
| - | |||
| - | These allow access to all characters on the account, and these are the type of keys that we require for [[it:auth|Auth]]. Much like the character keys these can be customized with limited access to certain API calls. | ||
| - | |||
| - | === Corporation Keys === | ||
| - | |||
| - | These are special case keys, they allow access for the /corp/ API calls on a CEO or Director's account. This is a massive change from the old system where a director had to hand over his personal Full API key to get this information, pontentially exposing their personal assets and items. | ||
| - | |||
| - | Corporation keys have a seperate permission set from a character/account key, so need to be setup differently. TEST requires a corporation key for each corporation, and if possible one key for each director (to allow us to load balance API requests over several keys). More details about this can be found by contacting your Schoolyard representive. | ||
| - | |||
| - | ===== Key Usage ===== | ||
| - | |||
| - | If you are worried that one of your API keys might have fallen into the wrong hands (or you just are curious what information programs and services you submitted your API info to request) you should check the [[https://community.eveonline.com/support/api-key/log/|API Access Log]]for your account. | ||
| - | |||
| - | As a rule of thumb you should generate new API keys every time you leave a corp - if you were in a player corp before joining TEST and think they still might have working API keys for your account you should generate new ones asap! Don't forget to update the information in your [[it:auth|Auth]] and forum profiles after generating new API keys. | ||
it/api_key.1546547315.txt.gz · Last modified: 2019/01/03 20:28 by Fof