These forums have been archived and are now read-only.

The new forums are live and can be found at https://forums.eveonline.com/

EVE Technology Lab

 
  • Topic is locked indefinitely.
 

API what does it all mean?
Author
Previous Topic Next Topic
Alexis Nightwish
#1 - 2014-10-19 18:39:37 UTC
Forgive me if this was answered somewhere, but I've been searching here, Google, and eve-search and can't find this.

When you are creating a new API key, how do you know what each of the items actually does? Some are self evident like "AccountBalance" but others are not. The most confusing one is "CharacterInfo" which is vague and it's listed twice.

Is there a FAQ somewhere that details what exactly these options would reveal to someone with the key?

CCP, could a mouseover be added to the page that would show you specifically what info each of the items contain?

CCP approaches problems in one of two ways: nudge or cludge

EVE Online's "I win!" Button

Fixing bombs, not the bombers
Chingy Chonga
The Dark Space Initiative
Scary Wormhole People
#2 - 2014-10-19 18:51:30 UTC
There are a couple things you can do.

General info can be found here:
http://wiki.eve-id.net/APIv2_Page_Index
and here:
https://neweden-dev.com/Main_Page

You can also install the postman extension into chrome and build your calls based on your api keys and it will return the xml response in the bottom so you get an exact idea of what you would be getting back. The extension can be found here:
https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm?hl=en
Alexis Nightwish
#3 - 2014-10-19 19:13:18 UTC
I'm not a software developer or anything. Just a player who wants to know what information I would be giving out when I select options on the API key generation page.

CCP approaches problems in one of two ways: nudge or cludge

EVE Online's "I win!" Button

Fixing bombs, not the bombers
Dragonaire
Here there be Dragons
#4 - 2014-10-20 01:49:42 UTC
Another way to see the type of info each API does is to make a test key or just add stuff to your existing Evemon key and look at the stuff through it. You may find it present the info in a form that makes it easier to understand for you what each does. In addition the neweden site is mostly used by/maintained by programmers but if you look at each of the API pages they generally describe each field as well in a mostly normal English way with just a few programming terms that you should be able to figure out as well.

Finds camping stations from the inside much easier. Designer of Yapeal for the Eve API. Check out the Yapeal PHP API Library thread.
Alexis Nightwish
#5 - 2014-10-20 02:21:17 UTC
Dragonaire wrote:
Another way to see the type of info each API does is to make a test key or just add stuff to your existing Evemon key and look at the stuff through it. You may find it present the info in a form that makes it easier to understand for you what each does. In addition the neweden site is mostly used by/maintained by programmers but if you look at each of the API pages they generally describe each field as well in a mostly normal English way with just a few programming terms that you should be able to figure out as well.

I think I found what I was looking for. Thanks!

CCP approaches problems in one of two ways: nudge or cludge

EVE Online's "I win!" Button

Fixing bombs, not the bombers
salacious necrosis
Garoun Investment Bank
Gallente Federation
#6 - 2014-10-23 17:32:45 UTC
Alexis Nightwish wrote:
Dragonaire wrote:
Another way to see the type of info each API does is to make a test key or just add stuff to your existing Evemon key and look at the stuff through it. You may find it present the info in a form that makes it easier to understand for you what each does. In addition the neweden site is mostly used by/maintained by programmers but if you look at each of the API pages they generally describe each field as well in a mostly normal English way with just a few programming terms that you should be able to figure out as well.

I think I found what I was looking for. Thanks!


On the off chance you didn't quite find everything...

(shameless-self-promotion)
If you add a key to EveKit, set it to auto-synchronize (or manually synchronize at least once), and wait a day, you can grab a snapshot and see all the data the EVE API would return for almost all the calls (we're missing planetary data at the moment). You don't have to wait a day if you create an EveKit access key and look at the data manually, but it's easier to just grab the zip of CSV files from the daily snapshot. Once you're satisfied, delete your account from EveKit or at least disable the EVE API key you used.
(\shameless-self-promotion)

You can, of course, make all the calls manually yourself by constructing URLs, or use one of the many other tools to download data.

Use EveKit ! - Tools for EVE Online 3rd party development
Alexis Nightwish
#7 - 2014-10-26 00:31:51 UTC
salacious necrosis wrote:
Alexis Nightwish wrote:
Dragonaire wrote:
Another way to see the type of info each API does is to make a test key or just add stuff to your existing Evemon key and look at the stuff through it. You may find it present the info in a form that makes it easier to understand for you what each does. In addition the neweden site is mostly used by/maintained by programmers but if you look at each of the API pages they generally describe each field as well in a mostly normal English way with just a few programming terms that you should be able to figure out as well.

I think I found what I was looking for. Thanks!


On the off chance you didn't quite find everything...

(shameless-self-promotion)
If you add a key to EveKit, set it to auto-synchronize (or manually synchronize at least once), and wait a day, you can grab a snapshot and see all the data the EVE API would return for almost all the calls (we're missing planetary data at the moment). You don't have to wait a day if you create an EveKit access key and look at the data manually, but it's easier to just grab the zip of CSV files from the daily snapshot. Once you're satisfied, delete your account from EveKit or at least disable the EVE API key you used.
(\shameless-self-promotion)

You can, of course, make all the calls manually yourself by constructing URLs, or use one of the many other tools to download data.

Some of it was a bit cryptic like the assets, but it gave me a good idea of what is pulled, thanks!

CCP approaches problems in one of two ways: nudge or cludge

EVE Online's "I win!" Button

Fixing bombs, not the bombers