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.
 

EVE Third Party Docs - Call To Action

First post
Author
Previous Topic Next Topic
salacious necrosis
Garoun Investment Bank
Gallente Federation
#1 - 2015-11-16 03:31:12 UTC
Dear Third Party Dev and Tool Community,

The CCP blessed third party docs site has been up for about nine months now. There are some new bits on the site that haven't been documented before, but the site is still well behind on things that are relatively well understood (e.g. XML API). Although this site is controlled by CCP, it is intended to be shaped through git pull requests from the EVE Online third party community, with corrections and clarifications supplied by CCP staff. Therefore, I very much consider it to be OUR site and it's up to us to make it the best and most complete EVE Online docs site out there.

To that end, I'd like to issue a call to action to make significant progress on the site. I propose completing the XML API docs portion of the site as a starting point. Even just a copy and reformat from NED would be progress as we can go back later and do further editing passes. There are instructions on how to contribute on the docs GitHub site. If you have questions, there are many on this forum who can help.

As of this writing, the following end points have not been documented:

  • Char - Blueprints
  • Char - Calendar Event Attendees
  • Char - Character Sheet
  • Char - Contracts
  • Char - ContractItems
  • Char - ContractBids
  • Char - Factional Warfare Stats
  • Char - Industry Jobs
  • Char - Industry Jobs History
  • Char - Kill Mails
  • Char - Locations
  • Char - Mail Bodies
  • Char - Mailing Lists
  • Char - Mail Messages
  • Char - Medals
  • Char - Notifications
  • Char - NotificationTexts
  • Char - PlanetaryColonies
  • Char - PlanetaryPins
  • Char - PlanetaryRoutes
  • Char - PlanetaryLinks
  • Char - Research
  • Char - Skill in Training
  • Char - Skill Queue
  • Char - Standings
  • Char - Upcoming Calendar Events
  • Char - Wallet Journal
  • Char - Wallet Transactions
  • Corp - Asset List
  • Corp - Blueprints
  • Corp - Contact List
  • Corp - Container Log
  • Corp - Contracts
  • Corp - ContractItems
  • Corp - ContractBids
  • Corp - Corporation Sheet
  • Corp - Customs Offices
  • Corp - Facilities
  • Corp - Factional Warfare Stats
  • Corp - Industry Jobs
  • Corp - Industry Jobs History
  • Corp - Kill Mails
  • Corp - Locations
  • Corp - Market Orders
  • Corp - Medals
  • Corp - Member Medals
  • Corp - Member Security
  • Corp - Member Security Log
  • Corp - Member Tracking
  • Corp - Outpost List
  • Corp - Outpost Service Detail
  • Corp - Shareholders
  • Corp - Standings
  • Corp - Starbase Details
  • Corp - Starbase List
  • Corp - Titles
  • Corp - Wallet Journal
  • Corp - Wallet Transactions
  • EVE - Alliance List
  • EVE - Character Affiliation
  • EVE - Character ID
  • EVE - Character Info
  • EVE - Character Name
  • EVE - Conquerable Station List
  • EVE - Error List
  • EVE - Factional Warfare Stats
  • EVE - Factional Warfare Top 100 Stats
  • EVE - RefTypes List
  • EVE - Skill Tree
  • EVE - Type Name
  • Map - Factional Warfare Systems (Occupancy Map)
  • Map - Jumps
  • Map - Kills

CCP has asked us to limit each pull request to one endpoint/file at a time (within reason). So if you're in, pick an endpoint to document and please post here which endpoint you're working on so we don't repeat work unnecessarily.

To kick things off, I'll take "Char - Blueprints". Thanks in advance to everyone who chips in.


Use EveKit ! - Tools for EVE Online 3rd party development
Captain Thunk
Explode. Now. Please.
Alliance. Now. Please.
#2 - 2015-11-16 11:13:14 UTC  |  Edited by: Captain Thunk
salacious necrosis wrote:


  • Char - Blueprints
  • Char - Calendar Event Attendees
  • Char - Character Sheet
  • Char - Contracts
  • Char - ContractItems
  • Char - ContractBids



I've done and submitted these, sorry I hadn't seen this post when I had started.

Really sorry if you did Char - Blueprints already :(

I was planning on ploughing through the rest of the Char sheets, if you want to get started on Corp - we can meet in the middle and use the power of Eve-O forums to coordinate our assault.

Or you could start at the back of Char and we'll meet in the middle, a lot will be repeated in Corp so easy to re-use the Char equivalents.

ProTip: Take the time to find related Dev Blogs and add them as references
salacious necrosis
Garoun Investment Bank
Gallente Federation
#3 - 2015-11-16 12:46:13 UTC
Captain Thunk wrote:
salacious necrosis wrote:


  • Char - Blueprints
  • Char - Calendar Event Attendees
  • Char - Character Sheet
  • Char - Contracts
  • Char - ContractItems
  • Char - ContractBids



I've done and submitted these, sorry I hadn't seen this post when I had started.

Really sorry if you did Char - Blueprints already :(

I was planning on ploughing through the rest of the Char sheets, if you want to get started on Corp - we can meet in the middle and use the power of Eve-O forums to coordinate our assault.

Or you could start at the back of Char and we'll meet in the middle, a lot will be repeated in Corp so easy to re-use the Char equivalents.

ProTip: Take the time to find related Dev Blogs and add them as references


No worries. Most of my char - blueprints update actually covered an attempt to document typeIDs.yaml, so that's still in the PR.

Here's what is left for those following at home:


  • Char - Factional Warfare Stats
  • Char - Industry Jobs
  • Char - Industry Jobs History
  • Char - Kill Mails
  • Char - Locations
  • Char - Mail Bodies
  • Char - Mailing Lists
  • Char - Mail Messages
  • Char - Medals
  • Char - Notifications
  • Char - NotificationTexts
  • Char - PlanetaryColonies
  • Char - PlanetaryPins
  • Char - PlanetaryRoutes
  • Char - PlanetaryLinks
  • Char - Research
  • Char - Skill in Training
  • Char - Skill Queue
  • Char - Standings
  • Char - Upcoming Calendar Events
  • Char - Wallet Journal
  • Char - Wallet Transactions
  • Corp - Asset List
  • Corp - Blueprints
  • Corp - Contact List
  • Corp - Container Log
  • Corp - Contracts
  • Corp - ContractItems
  • Corp - ContractBids
  • Corp - Corporation Sheet
  • Corp - Customs Offices
  • Corp - Facilities
  • Corp - Factional Warfare Stats
  • Corp - Industry Jobs
  • Corp - Industry Jobs History
  • Corp - Kill Mails
  • Corp - Locations
  • Corp - Market Orders
  • Corp - Medals
  • Corp - Member Medals
  • Corp - Member Security
  • Corp - Member Security Log
  • Corp - Member Tracking
  • Corp - Outpost List
  • Corp - Outpost Service Detail
  • Corp - Shareholders
  • Corp - Standings
  • Corp - Starbase Details
  • Corp - Starbase List
  • Corp - Titles
  • Corp - Wallet Journal
  • Corp - Wallet Transactions
  • EVE - Alliance List
  • EVE - Character Affiliation
  • EVE - Character ID
  • EVE - Character Info
  • EVE - Character Name
  • EVE - Conquerable Station List
  • EVE - Error List
  • EVE - Factional Warfare Stats
  • EVE - Factional Warfare Top 100 Stats
  • EVE - RefTypes List
  • EVE - Skill Tree
  • EVE - Type Name
  • Map - Factional Warfare Systems (Occupancy Map)
  • Map - Jumps
  • Map - Kills


Per your suggestion, I'll tackle Char - WalletTransactions next.

Use EveKit ! - Tools for EVE Online 3rd party development
Hel O'Ween
Men On A Mission
#4 - 2015-11-16 15:17:43 UTC
Captain Thunk wrote:

ProTip: Take the time to find related Dev Blogs and add them as references


The old Wikis (wiki.eve-id.net and neweden-dev.com) sometimes have nice references to old forum posts. One needs to rewrite the URL for making them work with the now read-only old EVE forums. But I think its worth the effort to perserve old DEV posts. I at least did so, with the APIs I covered.

EVEWalletAware - an offline wallet manager.
salacious necrosis
Garoun Investment Bank
Gallente Federation
#5 - 2015-11-19 12:25:57 UTC
PRs either added or merged for:

Char - WalletTransactions
Corp - WalletTransactions

Moving on to Char/Corp - WalletJournal. Here's what's left:


  • Char - Factional Warfare Stats
  • Char - Industry Jobs
  • Char - Industry Jobs History
  • Char - Kill Mails
  • Char - Locations
  • Char - Mail Bodies
  • Char - Mailing Lists
  • Char - Mail Messages
  • Char - Medals
  • Char - Notifications
  • Char - NotificationTexts
  • Char - PlanetaryColonies
  • Char - PlanetaryPins
  • Char - PlanetaryRoutes
  • Char - PlanetaryLinks
  • Char - Research
  • Char - Skill in Training
  • Char - Skill Queue
  • Char - Standings
  • Char - Upcoming Calendar Events
  • Char - Wallet Journal
  • Corp - Asset List
  • Corp - Blueprints
  • Corp - Contact List
  • Corp - Container Log
  • Corp - Contracts
  • Corp - ContractItems
  • Corp - ContractBids
  • Corp - Corporation Sheet
  • Corp - Customs Offices
  • Corp - Facilities
  • Corp - Factional Warfare Stats
  • Corp - Industry Jobs
  • Corp - Industry Jobs History
  • Corp - Kill Mails
  • Corp - Locations
  • Corp - Market Orders
  • Corp - Medals
  • Corp - Member Medals
  • Corp - Member Security
  • Corp - Member Security Log
  • Corp - Member Tracking
  • Corp - Outpost List
  • Corp - Outpost Service Detail
  • Corp - Shareholders
  • Corp - Standings
  • Corp - Starbase Details
  • Corp - Starbase List
  • Corp - Titles
  • Corp - Wallet Journal
  • EVE - Alliance List
  • EVE - Character Affiliation
  • EVE - Character ID
  • EVE - Character Info
  • EVE - Character Name
  • EVE - Conquerable Station List
  • EVE - Error List
  • EVE - Factional Warfare Stats
  • EVE - Factional Warfare Top 100 Stats
  • EVE - RefTypes List
  • EVE - Skill Tree
  • EVE - Type Name
  • Map - Factional Warfare Systems (Occupancy Map)
  • Map - Jumps
  • Map - Kills

Use EveKit ! - Tools for EVE Online 3rd party development
salacious necrosis
Garoun Investment Bank
Gallente Federation
#6 - 2015-11-19 19:29:51 UTC
Knocked off Char/Corp - WalletJournal. Here's what's left:


  • Char - Factional Warfare Stats
  • Char - Industry Jobs
  • Char - Industry Jobs History
  • Char - Kill Mails
  • Char - Locations
  • Char - Mail Bodies
  • Char - Mailing Lists
  • Char - Mail Messages
  • Char - Medals
  • Char - Notifications
  • Char - NotificationTexts
  • Char - PlanetaryColonies
  • Char - PlanetaryPins
  • Char - PlanetaryRoutes
  • Char - PlanetaryLinks
  • Char - Research
  • Char - Skill in Training
  • Char - Skill Queue
  • Char - Standings
  • Char - Upcoming Calendar Events
  • Corp - Asset List
  • Corp - Blueprints
  • Corp - Contact List
  • Corp - Container Log
  • Corp - Contracts
  • Corp - ContractItems
  • Corp - ContractBids
  • Corp - Corporation Sheet
  • Corp - Customs Offices
  • Corp - Facilities
  • Corp - Factional Warfare Stats
  • Corp - Industry Jobs
  • Corp - Industry Jobs History
  • Corp - Kill Mails
  • Corp - Locations
  • Corp - Market Orders
  • Corp - Medals
  • Corp - Member Medals
  • Corp - Member Security
  • Corp - Member Security Log
  • Corp - Member Tracking
  • Corp - Outpost List
  • Corp - Outpost Service Detail
  • Corp - Shareholders
  • Corp - Standings
  • Corp - Starbase Details
  • Corp - Starbase List
  • Corp - Titles
  • EVE - Alliance List
  • EVE - Character Affiliation
  • EVE - Character ID
  • EVE - Character Info
  • EVE - Character Name
  • EVE - Conquerable Station List
  • EVE - Error List
  • EVE - Factional Warfare Stats
  • EVE - Factional Warfare Top 100 Stats
  • EVE - RefTypes List
  • EVE - Skill Tree
  • EVE - Type Name
  • Map - Factional Warfare Systems (Occupancy Map)
  • Map - Jumps
  • Map - Kills

Use EveKit ! - Tools for EVE Online 3rd party development
CCP FoxFour
C C P
C C P Alliance
#7 - 2015-11-21 21:27:58 UTC
Thank you very much for all the work guys! CCP Tellus and I do try and respond to pull requests and issues as quickly as possible. If things are taking a while though don't be afraid to post another comment reminding us or contacting us directly. We often get caught up in things and forget. :)

@CCP_FoxFour // Technical Designer // Team Tech Co

Third-party developer? Check out the official developers site for dev blogs, resources, and more.
salacious necrosis
Garoun Investment Bank
Gallente Federation
#8 - 2015-11-24 02:31:18 UTC
Nice flurry of activity today! Here is what's left:


  • Char - Factional Warfare Stats
  • Char - Industry Jobs
  • Char - Industry Jobs History
  • Char - Kill Mails
  • Char - Locations
  • Char - Mail Bodies
  • Char - Mailing Lists
  • Char - Mail Messages
  • Char - Medals
  • Char - Notifications
  • Char - NotificationTexts
  • Char - PlanetaryColonies
  • Char - PlanetaryPins
  • Char - PlanetaryRoutes
  • Char - PlanetaryLinks
  • Char - Research
  • Char - Skill in Training
  • Char - Skill Queue
  • Char - Standings
  • Char - Upcoming Calendar Events
  • Corp - Asset List
  • Corp - Blueprints
  • Corp - Contact List
  • Corp - Container Log
  • Corp - Contracts
  • Corp - ContractItems
  • Corp - ContractBids
  • Corp - Corporation Sheet
  • Corp - Customs Offices
  • Corp - Facilities
  • Corp - Factional Warfare Stats
  • Corp - Industry Jobs
  • Corp - Industry Jobs History
  • Corp - Kill Mails
  • Corp - Locations
  • Corp - Market Orders
  • Corp - Medals
  • Corp - Member Medals
  • Corp - Member Security
  • Corp - Member Security Log
  • Corp - Member Tracking
  • Corp - Outpost List
  • Corp - Outpost Service Detail
  • Corp - Shareholders
  • Corp - Standings
  • Corp - Starbase Details
  • Corp - Starbase List
  • Corp - Titles
  • EVE - Character Info
  • EVE - Character Name
  • EVE - Conquerable Station List
  • EVE - Error List
  • EVE - Factional Warfare Stats
  • EVE - Factional Warfare Top 100 Stats
  • EVE - RefTypes List
  • EVE - Skill Tree
  • EVE - Type Name
  • Map - Factional Warfare Systems (Occupancy Map)
  • Map - Jumps
  • Map - Kills

Use EveKit ! - Tools for EVE Online 3rd party development
CCP FoxFour
C C P
C C P Alliance
#9 - 2015-11-25 11:55:05 UTC  |  Edited by: CCP FoxFour
Some serious progress has been made on this over the last while, really awesome to see!

Just merged the jumps and kills endpoints, ref types was yesterday along with conquerable stations.

@CCP_FoxFour // Technical Designer // Team Tech Co

Third-party developer? Check out the official developers site for dev blogs, resources, and more.
Ereshgikal
Wharf Crusaders
#10 - 2015-11-30 04:07:13 UTC
Awesome initiative!

Just wanted to point out that Char - KillLog is missing from the ToDo list, and it seems most other API-sites have also failed to document this endpoint.

Interestingly enough, KillLog is listed in /Api/CallList, but KillMails is not.
salacious necrosis
Garoun Investment Bank
Gallente Federation
#11 - 2015-11-30 13:04:07 UTC
Ereshgikal wrote:
Awesome initiative!

Just wanted to point out that Char - KillLog is missing from the ToDo list, and it seems most other API-sites have also failed to document this endpoint.

Interestingly enough, KillLog is listed in /Api/CallList, but KillMails is not.


I vote that we excise the demon that is KillLog by NOT documenting it. I would go even further and propose that CCP retire this call completely, but that's another discussion.

KillLog is an older call with unfortunate caching behavior. I don't know of any "modern" APIs that use it anymore. Most everyone has switched to KillMail these days. My forum search fu has failed me, so I can't find where KillMail was announced, but the only difference between the two I'm aware of is this:


  • KillLog is on a long cache timer that only works once before the cache timeout. Hitting it again before the cache has expired will return an error.
  • KillMails is on a short cache timer and can be called multiple times before the cache timeout without ill effect.


I can't think of a great reason for KIllLog to still exist.

Use EveKit ! - Tools for EVE Online 3rd party development
Captain Thunk
Explode. Now. Please.
Alliance. Now. Please.
#12 - 2015-11-30 14:11:58 UTC
salacious necrosis wrote:
Ereshgikal wrote:
Awesome initiative!

Just wanted to point out that Char - KillLog is missing from the ToDo list, and it seems most other API-sites have also failed to document this endpoint.

Interestingly enough, KillLog is listed in /Api/CallList, but KillMails is not.


I vote that we excise the demon that is KillLog by NOT documenting it. I would go even further and propose that CCP retire this call completely, but that's another discussion.

KillLog is an older call with unfortunate caching behavior. I don't know of any "modern" APIs that use it anymore. Most everyone has switched to KillMail these days. My forum search fu has failed me, so I can't find where KillMail was announced, but the only difference between the two I'm aware of is this:


  • KillLog is on a long cache timer that only works once before the cache timeout. Hitting it again before the cache has expired will return an error.
  • KillMails is on a short cache timer and can be called multiple times before the cache timeout without ill effect.


I can't think of a great reason for KIllLog to still exist.


iirc KillLog only exists for legacy applications that haven't updated (While KillMails is better, there are many situations where either suffices so there's no need to force developers to update if they don't need to).

Might be best to include it, but explain the differences in cacheing and redirect to KillMails for actual information - this acknowledges its existence while leaving absolutely no doubt to new developers that you really should not be using KillLog anymore.

I'll handle KillLog and KillMail as I know a bunch of tricks and tips which would be well worth going into the page, afterwhich anyone can edit in ones I've missed.

Apologies for not doing any more for a while, something came up.
salacious necrosis
Garoun Investment Bank
Gallente Federation
#13 - 2015-12-04 03:52:13 UTC
Great week of progress. Here's what's left:


  • Char - Industry Jobs
  • Char - Industry Jobs History
  • Char - Kill Mails
  • Char - Locations
  • Char - Mail Bodies
  • Char - Medals
  • Char - Notifications
  • Char - NotificationTexts
  • Char - PlanetaryColonies
  • Char - PlanetaryPins
  • Char - PlanetaryRoutes
  • Char - PlanetaryLinks
  • Char - Research
  • Char - Skill in Training
  • Char - Skill Queue
  • Char - Standings
  • Char - Upcoming Calendar Events
  • Corp - Asset List
  • Corp - Blueprints
  • Corp - Contact List
  • Corp - Container Log
  • Corp - Contracts
  • Corp - ContractItems
  • Corp - ContractBids
  • Corp - Corporation Sheet
  • Corp - Customs Offices
  • Corp - Facilities
  • Corp - Factional Warfare Stats
  • Corp - Industry Jobs
  • Corp - Industry Jobs History
  • Corp - Kill Mails
  • Corp - Locations
  • Corp - Market Orders
  • Corp - Medals
  • Corp - Member Medals
  • Corp - Member Security
  • Corp - Member Security Log
  • Corp - Member Tracking
  • Corp - Outpost List
  • Corp - Outpost Service Detail
  • Corp - Shareholders
  • Corp - Standings
  • Corp - Starbase Details
  • Corp - Starbase List
  • Corp - Titles
  • EVE - Factional Warfare Stats
  • EVE - Factional Warfare Top 100 Stats
  • EVE - Skill Tree

Use EveKit ! - Tools for EVE Online 3rd party development