An open API service indexing awesome lists of open source software.

https://github.com/incomplete-infinity/esi-docs

Official documentation for The Eve Swagger Interface
https://github.com/incomplete-infinity/esi-docs

api-docs api-documentation esi esi-docs eve-online eve-online-api-documentation eve-swagger-interface swagger

Last synced: 3 months ago
JSON representation

Official documentation for The Eve Swagger Interface

Awesome Lists containing this project

README

          

# ESI Documentation
ESI is the name of EVE Online's publicly available API, allowing you to query the game itself to get info about your character, corporation and more. This documentation can be used as a jumping off point to learn how to begin developing against ESI or as a place to learn some of the ESI concepts that are harder to grasp.

We appreciate help from the EVE Online community and encourage pull requests if you feel any documentation is missing. Our wonderful [ESI community](https://github.com/esi/esi-issues/blob/master/contributors.md#esi-community-members) helps to moderate this documentation.

## Important Online Resources
The following is a list of important online resources for ESI development.

* Watch the [third party developer blog](https://developers.eveonline.com/blog) for updates about ESI.
* Make bug or feature requests at our [esi-issues](https://github.com/esi/esi-issues) Github page.
* For real time discussion about ESI join us on our #esi channel in Slack by following [these instructions](https://www.fuzzwork.co.uk/tweetfleet-slack-invites/).
* Watch the [ESI changelog](https://github.com/esi/esi-issues/blob/master/changelog.md) for upcoming endpoint changes. Updates are broadcast in the #esi channel, or you can [subscribe to email notifications](https://app.github-file-watcher.com/?repository=esi/esi-issues&glob=changelog.md).

## Table of Contents
If you're adding a new document, please be sure to include a link here somewhere.

### General

- [ESI Introduction](docs/esi_introduction.md)
- [Frequently Asked Questions](docs/FAQ.md)
- [Transitioning from XML](docs/XML_to_ESI.md)
- [Transitioning from CREST](docs/CREST_to_ESI.md)
- [What defines a breaking change](docs/breaking_changes.md)
- [Warning headers explained](docs/warning_header.md)
- [ESI scrapes](docs/esi_scrapes.md)

### Using ESI Data

- [Dogma](docs/dogma.md)
- [ID Ranges](docs/id_ranges.md)
- [Useful Formulae](docs/useful_formulae.md)
- [Asset location_id](docs/asset_location_id.md)
- [Notifications](docs/notifications.md)

### Common Scenarios
- [Resolve Structure IDs](docs/scenarios/resolve_structure_ids.md)
- [Retrieve Structure Markets](docs/scenarios/structure_markets.md)

### SSO

- [Introduction](docs/sso/README.md)
- [High level overview of SSO authorization flow](docs/sso/sso_authorization_flow.md)
- [Creating an EVE Online SSO application](docs/sso/creating_sso_application.md)
- [OAuth 2.0 for web based applications](docs/sso/web_based_sso_flow.md)
- [OAuth 2.0 for desktop/mobile applications](docs/sso/native_sso_flow.md)
- [Refreshing access tokens](docs/sso/refreshing_access_tokens.md)
- [Validating EVE SSO JWT tokens](docs/sso/validating_eve_jwt.md)
- [Sending authenticated requests to ESI](docs/sso/sending_esi_auth_request.md)
- [Migrating from SSO v1 to v2](docs/sso/migrate_v1_v2.md)
- [Old documentation](https://github.com/ccpgames/eveonline-third-party-documentation/blob/master/docs/sso/index.md)

### Other Resources

- [Static Data Export](docs/sde_introduction.md)
- [SDE Conversions](docs/sde_conversions.md)
- [SDE Complements](docs/sde_complements.md)
- [Image Server](docs/image_server.md)

### Community FAQs

- [Guidelines](docs/guidelines.md)
- [Best Practices](docs/best_practices.md)
- [Quick URL Reference](docs/quick_reference.md)
- [Developer License](docs/developer_license.md)