Third Party Developer Blog

rss Viewing archived items for 2017

Jun
8

ESI Tutorial: Using Swagger Codegen to Generate a Client API

CCP Zoetrope | 2017-06-08 19:48
This blog post is part of a series of blogs examining best practices for ESI development. Each blog will be published on the 8th of each month during the journey towards XML API and CREST’s termination date. The legacy APIs will be terminated on May 8th, 2018, or earlier if metrics signal a trivial level of usage. Here on this blog we regularly mention the fact that ESI uses a framework called Swagger. In fact, the word "Swagger" is directly in the name (EVE Swagger Interface)! We also regularly mention that Swagger provides the capability of auto generating code for the programming language of your choice. However, it's not entirely obvious from looking at Swagger documentation how one should go about generating and using a client library. This blog will cover two ways to generate a library using ESI with tools provided ... read more
May
26

Caution: AccountStatus.xml.aspx Deprecated and Unreliable

Team Tech Co | 2017-05-26 16:50
Currently, the XML API endpoint /account/AccountStatus.xml.aspx is returning unreliable data. This endpoint has been officially deprecated since November 2016. Team Tech Co. has decided that this issue is not considered a "critical bug". As such, there are no plans to make changes to the endpoint to fix this issue (per our announcement here). The reasons we did not class it as such are: Account level information will not be available in ESI. Players receive notification e-mails directly from CCP if their non-recurring subscription is approaching expiry. This endpoint's original intent is no longer relevant, as players are not prevented from logging into EVE if their Omega status lapses. Despite being deprecated and unreliable, we will be leaving the endpoint active so as to not disrupt applications that would break if it ... read more
May
8

ESI Best Practices: Generating Code With Underscore Routes

CCP Bartender | 2017-05-08 16:00
This blog post is part of a series of blogs examining best practices for ESI development. Each blog will be published on the 8th of each month during the journey towards XML API and CREST’s termination date. The legacy APIs will be terminated on May 8th, 2018, or earlier if metrics signal a trivial level of usage. This blog explains best practices for autogenerating language specific clients from the ESI swagger spec. When generating code from one of the named routes (e.g. https://esi.tech.ccp.is/latest/swagger.json ), you may have noticed the resulting client library uses /latest as the version in all its URL calls. You can see why if you look at this fragment of the swagger spec from the above URL: { "basePath": "/latest", "host": "esi.tech.ccp.is", "info": { "description": "An ... read more
May
5

Changes to the public citadel endpoint

CCP Bartender | 2017-05-05 15:07
Greetings all! On Tuesday 9th of May, Team Tech Co will be releasing a behavior change to the /universe/structures/ endpoint. This change will affect all versions of the endpoint, and although it will not change the specification of the endpoint (so you won't need to update your code), you may wish to know about how the behavior changed and why. Until now, this endpoint has been returning the structure ID’s of every structure that had the "public" entity on its ACL's allowed docking rights. This was done on the basis that such citadels are clearly visible in space and in the in-game structure browser, and thus matched information given in game. However, this is not quite correct. It is possible to add the "public" entity to one's ACL's, and then explicitly ban someone. Some of you may have noticed that if ... read more
Feb
1

Breaking changes and you - How to use alt-routes to enhance your sanity

CCP Bartender | 2017-02-01 14:19
Afternoon developers! We've mentioned it before, but I'd like to give everyone a clear best-practices guide to how to use alt-routes in ESI to maintain application stability against a constantly evolving API. Schedule of breaking changes Before I get into that though, we previously said we'd be updating a forum thread with all planned breaking changes to ESI. That's turned out to be a bad solution to letting you all know when we're planning to change stuff. It's hard for you to read at a glance, and it's totally outside the tools we use day-to-day to develop ESI. We've moved this information to the ESI deployment timeline, here: https://github.com/ccpgames/esi-issues/projects/2. The timeline shows the deployment of totally new routes, but it also shows the deployment of routes that are going to have breaking changes. Consider the following screenshot: ... read more
Jan
24

ESI Mail Scopes Are Now Released

CCP Bartender | 2017-01-24 17:57
Greetings developers! Team Tech Co. is pleased to announce that all mails scopes (esi-mail.organize_mail.v1, esi-mail.read_mail.v1, and esi-mail.send_mail.v1) have now been released and are available for general use. We're excited to see what everyone does with them! (Thunderbird plugin, I want to believe!) However, I'd like to drop a quick reminder about section 2.3 of the EVE developer license agreement: 'Developer acknowledges and agrees that no Application shall be used [...] (b) as a means of phishing or spamming' Our third party developers have great judgement when it comes to these types of issues, but I wish to make it clear that one of our key indicators of "spam" will be "whether other people think you are sending spam". Applications that create work for our GM's by sending large volumes of unwanted mail (thus prompting people to create tickets asking us to ... read more