User:Rayanth/Sandbox2: Difference between revisions

Line 31:

Character-Focused scopes:

=BreakBreak=

=Existing Page=

EVE Swagger Interface (ESI) is an API to get data from the EVE server. It replaces [[CREST]] and the XML API which were shut down on May 8th, 2018.<ref>https://developers.eveonline.com/blog/article/important-information-on-the-future-of-the-eve-api</ref>

Remember that scamming with API is specifically not allowed<ref name="scamming">[https://developers.eveonline.com/blog/article/reminder-no-scamming Reminder to Developers: No Scamming]</ref>

Several guides on how to use ESI exist:

* [https://forums.eveonline.com/t/3-3-0-gesi-google-sheets-esi-library/13406 GESI - Google Sheets ESI Library] [https://developers.eveonline.com/blog/article/using-esi-with-google-sheets Guide for it on the Third Party Developer Blog]

* [https://www.fuzzwork.co.uk/2017/03/14/using-esi-google-sheets/ Using ESI with Google Sheets]

* [https://wiki.zansha.space/index.php/SSO_Authentication_in_Microsoft_Power_Query Guide on how to use ESI with MS Excel]

Further some libraries exist to use ESI with Python. For further information see the "See Also" section.

==API authorization managment==

You can manage API permissions from you at https://community.eveonline.com/support/third-party-applications/

In here you can see all applications that have access to your API. You can see exactly what scopes you have authorized for them. You can also revoke authorizations.

==See also==

* https://docs.esi.evetech.net/ Community-maintained documentation for ESI.

* https://eveonline-third-party-documentation.readthedocs.io/en/latest/esi/index.html CCP's documentation on ESI.

* https://github.com/esi/esi-issues Git Repo for tracking issues with ESI.

* https://community.eveonline.com/news/dev-blogs/introducing-esi/ Original announcement to introduce ESI.

* https://esi.evetech.net/ui/

* https://github.com/devfleet/awesome-eve#developer-tools-resources-and-apis Some resources to work with ESI.

==References==

<nowiki>[[Category:API]]</nowiki>

=BreakBreakBreak=

=NewPage=

EVE Swagger Interface (ESI) is an API that can be used by [[Third-party_tools|third party applications]] to interact with data from the EVE game servers. It replaces [[CREST]] and the XML API which were shut down on May 8th, 2018.<ref>https://developers.eveonline.com/blog/article/important-information-on-the-future-of-the-eve-api</ref>

ESI has both public-data and authenticated endpoints, the latter of which require a character to log in via [[Eve SSO]] to their character account to gain access to information specific to their character or, provided they have the appropriate corporate roles, their corporation. At present there are 81 public-data and 125 Authenticated endpoints (206 total).

CCP has indicated that their goal is to completely replace the [[Static Data Export|Static Data Export]] (SDE) with ESI, but as of December 2019, there are still many missing features.

As a reminder to developers, it is expressly forbidden for developers of third party applications to use them for ill intent<ref name="scamming">[https://developers.eveonline.com/blog/article/reminder-no-scamming Reminder to Developers: No Scamming]</ref><ref>https://developers.eveonline.com/resource/license-agreement</ref>

ESI and SSO are commonly used together, however they do have independent features and uses as well. For this reason, they have been split into their own articles. See [[SSO]] for information regarding the character authentication (and management thereof) aspect.

==ESI Endpoints==

ESI provides 206 endpoints, 81 of which related to public data and need no character or client authentication, and 135 of which are authenticated as they relate to privileged information about specific characters or corporations.

The general categories these endpoints fall under are:

{|

! Category !! Public Endpoints !! Authenticated !! Description

|-

| Alliances || 4 || || General information about Alliances and their member corporations

|-

| Assets || || 6 || Inventory details for characters and corporations

|-

| Bookmarks || || 4 || All of a character or <strike>corporation's</strike><ref>https://developers.eveonline.com/blog/article/temporary-blackout-of-esi-bookmarks</ref> bookmarks and bookmark folders

|-

| Calendar || || 4 || Read and respond to a character's calendar events

|-

| Character || 4 || 11 || Information relating specifically to a character, where it does not fall under any other category.

|-

| Clones || || 2 || Information on a character's clones and their active implants

|-

| Contacts || || 9 || Read Contacts lists for characters, corporations and alliances, and edit them for characters.

|-

| Contracts || 3 || 6 || List public, character and corporate contracts, bids placed on them, and items contained in them.

|-

| Corporation || 4 || 18 || Information relating specifically to a corporation, where it does not fall under any other category.

|-

| Dogma || 5 || || Information regarding Dogma, EVE's system for attributes on items and entities.

|-

| Faction Warfare || 6 || 2 || Public statistics on faction warfare, systems, leaderboards, and a character's statistics.

|-

| Fittings || || 3 || View, create or delete a character's in-game saved fittings.

|-

| Fleets || || 14 || Provides endpoints for a complete breakdown of a fleet's composition, and allows managing it externally.

|-

| Incursions || 1 || || A list of currently active Incursions and some basic info about them

|-

| Industry || 2 || 6 || System Cost Indices, Industry facilities, and all information about a character's active industry jobs.

|-

| Insurance || 1 || || A list of insurance prices for all classes of ships.

|-

| Killmails || 1 || 2 || Retrieve killmails relating to a character, or all details on a killmail for which you have the appropriate information.

|-

| Location || || 3 || View whether a character is online, what they're flying, and where they are located.

|-

| Loyalty || 1 || 1 || List offers available from a provided NPC Corporation's LP Store, and a character's available LP.

|-

| Mail || || 9 || All actions related to viewing, sending and deleting in-game mail for a character.

|-

| Market || 6 || 5 || Market orders and histories, as well as a character or corporation's specific orders.

|-

| Opportunities || 4 || 1 || A list of tasks associated with the New Player Experience / Tutorial, and whether a character has completed them.

|-

| Planetary Interaction || 1 || 3 || Details on a character's planetary colonies and their layouts, as well as public information on PI Schematics.

|-

| Routes || 1 || || Use the game's algorithms to calculate a route between two systems

|-

| Search || 1 || 1 || Perform a search on the provided string against the chosen categories. If for a character, will also search private things the character can see.

|-

| Skills || || 3 || Information on a character's attributes, skills and skill training queue.

|-

| Sovereignty || 3 || || Lists of sovereignty campaigns, systems and structures.

|-

| Status || 1 || || Status of the game: Whether it's running, what version, and how many players are logged in.

|-

| Universe || 30 || || Just about all general public, static data in the game.

|-

| User Interface || || 5 || Allows opening certain UI windows for a character if they are logged in to the game.

|-

| Wallet || || 6 || Character and Corporation wallet balances and transactions.

|-

| Wars || 3 || || Details on all wars that have happened in the game, including their killmails.

|}

@@ Line 31: / Line 31: @@
 Character-Focused scopes:
+=BreakBreak=
+=Existing Page=
+{{stub}}
+EVE Swagger Interface (ESI) is an API to get data from the EVE server. It replaces [[CREST]] and the XML API which were shut down on May 8th, 2018.<ref>https://developers.eveonline.com/blog/article/important-information-on-the-future-of-the-eve-api</ref>
+Remember that scamming with API is specifically not allowed<ref name="scamming">[https://developers.eveonline.com/blog/article/reminder-no-scamming Reminder to Developers: No Scamming]</ref>
+Several guides on how to use ESI exist:
+* [https://forums.eveonline.com/t/3-3-0-gesi-google-sheets-esi-library/13406 GESI - Google Sheets ESI Library]  [https://developers.eveonline.com/blog/article/using-esi-with-google-sheets Guide for it on the Third Party Developer Blog]
+* [https://www.fuzzwork.co.uk/2017/03/14/using-esi-google-sheets/ Using ESI with Google Sheets]
+* [https://wiki.zansha.space/index.php/SSO_Authentication_in_Microsoft_Power_Query Guide on how to use ESI with MS Excel]
+Further some libraries exist to use ESI with Python. For further information see the "See Also" section.
+==API authorization managment==
+You can manage API permissions from you at https://community.eveonline.com/support/third-party-applications/
+In here you can see all applications that have access to your API. You can see exactly what scopes you have authorized for them. You can also revoke authorizations.
+==See also==
+* https://docs.esi.evetech.net/ Community-maintained documentation for ESI.
+* https://eveonline-third-party-documentation.readthedocs.io/en/latest/esi/index.html CCP's documentation on ESI.
+* https://github.com/esi/esi-issues Git Repo for tracking issues with ESI.
+* https://community.eveonline.com/news/dev-blogs/introducing-esi/ Original announcement to introduce ESI.
+* https://esi.evetech.net/ui/
+* https://github.com/devfleet/awesome-eve#developer-tools-resources-and-apis Some resources to work with ESI.
+==References==
+<references />
+<nowiki>[[Category:API]]</nowiki>
+=BreakBreakBreak=
+=NewPage=
+EVE Swagger Interface (ESI) is an API that can be used by [[Third-party_tools|third party applications]] to interact with data from the EVE game servers. It replaces [[CREST]] and the XML API which were shut down on May 8th, 2018.<ref>https://developers.eveonline.com/blog/article/important-information-on-the-future-of-the-eve-api</ref>
+ESI has both public-data and authenticated endpoints, the latter of which require a character to log in via [[Eve SSO]] to their character account to gain access to information specific to their character or, provided they have the appropriate corporate roles, their corporation. At present there are 81 public-data and 125 Authenticated endpoints (206 total).
+CCP has indicated that their goal is to completely replace the [[Static Data Export|Static Data Export]] (SDE) with ESI, but as of December 2019, there are still many missing features.
+As a reminder to developers, it is expressly forbidden for developers of third party applications to use them for ill intent<ref name="scamming">[https://developers.eveonline.com/blog/article/reminder-no-scamming Reminder to Developers: No Scamming]</ref><ref>https://developers.eveonline.com/resource/license-agreement</ref>
+ESI and SSO are commonly used together, however they do have independent features and uses as well. For this reason, they have been split into their own articles. See [[SSO]] for information regarding the character authentication (and management thereof) aspect.
+==ESI Endpoints==
+ESI provides 206 endpoints, 81 of which related to public data and need no character or client authentication, and 135 of which are authenticated as they relate to privileged information about specific characters or corporations.
+The general categories these endpoints fall under are:
+{|
+! Category !! Public Endpoints !! Authenticated !! Description
+|-
+| Alliances || 4 || || General information about Alliances and their member corporations
+|-
+| Assets || || 6 || Inventory details for characters and corporations
+|-
+| Bookmarks || || 4 || All of a character or <strike>corporation's</strike><ref>https://developers.eveonline.com/blog/article/temporary-blackout-of-esi-bookmarks</ref> bookmarks and bookmark folders
+|-
+| Calendar || || 4 || Read and respond to a character's calendar events
+|-
+| Character || 4 || 11 || Information relating specifically to a character, where it does not fall under any other category.
+|-
+| Clones || || 2 || Information on a character's clones and their active implants
+|-
+| Contacts || || 9 || Read Contacts lists for characters, corporations and alliances, and edit them for characters.
+|-
+| Contracts || 3 || 6 || List public, character and corporate contracts, bids placed on them, and items contained in them.
+|-
+| Corporation || 4 || 18 || Information relating specifically to a corporation, where it does not fall under any other category.
+|-
+| Dogma || 5 || || Information regarding Dogma, EVE's system for attributes on items and entities.
+|-
+| Faction Warfare || 6 || 2 || Public statistics on faction warfare, systems, leaderboards, and a character's statistics.
+|-
+| Fittings || || 3 || View, create or delete a character's in-game saved fittings.
+|-
+| Fleets || || 14 || Provides endpoints for a complete breakdown of a fleet's composition, and allows managing it externally.
+|-
+| Incursions || 1 || || A list of currently active Incursions and some basic info about them
+|-
+| Industry || 2 || 6 || System Cost Indices, Industry facilities, and all information about a character's active industry jobs.
+|-
+| Insurance || 1 || || A list of insurance prices for all classes of ships.
+|-
+| Killmails || 1 || 2 || Retrieve killmails relating to a character, or all details on a killmail for which you have the appropriate information.
+|-
+| Location || || 3 || View whether a character is online, what they're flying, and where they are located.
+|-
+| Loyalty || 1 || 1 || List offers available from a provided NPC Corporation's LP Store, and a character's available LP.
+|-
+| Mail || || 9 || All actions related to viewing, sending and deleting in-game mail for a character.
+|-
+| Market || 6 || 5 || Market orders and histories, as well as a character or corporation's specific orders.
+|-
+| Opportunities || 4 || 1 || A list of tasks associated with the New Player Experience / Tutorial, and whether a character has completed them.
+|-
+| Planetary Interaction || 1 || 3 || Details on a character's planetary colonies and their layouts, as well as public information on PI Schematics.
+|-
+| Routes || 1 || || Use the game's algorithms to calculate a route between two systems
+|-
+| Search || 1 || 1 || Perform a search on the provided string against the chosen categories. If for a character, will also search private things the character can see.
+|-
+| Skills || || 3 || Information on a character's attributes, skills and skill training queue.
+|-
+| Sovereignty || 3 || || Lists of sovereignty campaigns, systems and structures.
+|-
+| Status || 1 || || Status of the game: Whether it's running, what version, and how many players are logged in.
+|-
+| Universe || 30 || || Just about all general public, static data in the game.
+|-
+| User Interface || || 5 || Allows opening certain UI windows for a character if they are logged in to the game.
+|-
+| Wallet || || 6 || Character and Corporation wallet balances and transactions.
+|-
+| Wars || 3 || || Details on all wars that have happened in the game, including their killmails.
+|}