Skip to content

SSO ESI

Mark Friedrich edited this page Jul 20, 2018 · 5 revisions

Pathfinder requires CCP´s SSO authentication API to work (→documentation).

CCP´s ESI API provides a set of endpoints that feed Pathfinder with data (e.g. Character data, corporation data, system jump statistics,....)

There is no user specific data (e.g. hashed passwords,...) stored in a local DB. This is much more secure, than doing all the login stuff in Pathfinder itself. Therefore you have to register your application on CCPs developer page.

Registration URL: https://developers.eveonline.com/applications


1. Register installation

  1. Go to "MANAGE APPLICATIONS" → "CREATE NEW APPLICATION"
  • Choose a Name of your choice for your installation (e.g. "Pathfinder")
  • Enter a Description for this installation
  • Change "CONNECTION TYPE" to "Authentication & API Access" (this will grant you access to ESI API endpoints)
  • Add all required "PERMISSIONS" (scopes). Compare with CCP_ESI_SCOPES in environment.ini
  • Set your "CALLBACK URL"
    • Set https://[YOUR_DOMAIN]/sso/callbackAuthorization. This is the redirect URL for any SSO login.
  • Click "CREATE APPLICATION"
When you are done, it should look like this:


2. Set CCP_SSO_CLIENT_ID and CCP_SSO_SECRET_KEY

You should now receive a Client ID and Secret Key from that page. Both keys are unique and required by Pathfinder. The CLIENT_ID is used to to identify your installation and is used in any ESI API request. The Secret Key is private and works as a validation token (keep this key private!)

  • Add both keys to your environment.ini config file.

3. You are done! - Check if your login works


Additional Information [optional]

  • With the default configuration, the DEVELOP environment section uses "singularity" as data source for ESI API calls. This means, any in-game action (e.g. character tracking, set waypoints,...) will happen based on your SISI- EVE-ONLINE client. This can be changed by editing CCP_ESI_DATASOURCE in your environment.ini file.
  • In case ESI is down (e.g. daily EVE server downtime), you will not able to log in into Pathfinder as well.