Difference between revisions of "Archive:Updating an EVE University API key"

From EVE University Wiki
Jump to: navigation, search
(Tutorial page to help both new players applying to EVE Uni as well as existing members after an API mask change, for example.)
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
+
{{HR Navbar}}{{Historical}} __NOTOC__
 
=What is the EVE Uni API key=
 
=What is the EVE Uni API key=
 
The University requires every one of its members, may it be students, staff or faculty, to provide an API key. What in the name of Bob is an API key, will you ask ? Well, it is a tool CCP devised in order to allow 3rd party tools (such as EVEmon, EFT, Pyfa, Fleet-up, to name a few) to pull information from your account '''without being able to take any actions in your stead''' - in short, it allows you to give a very controlled monitoring right to a third party.
 
The University requires every one of its members, may it be students, staff or faculty, to provide an API key. What in the name of Bob is an API key, will you ask ? Well, it is a tool CCP devised in order to allow 3rd party tools (such as EVEmon, EFT, Pyfa, Fleet-up, to name a few) to pull information from your account '''without being able to take any actions in your stead''' - in short, it allows you to give a very controlled monitoring right to a third party.
 
Most corporations of significance in EVE will require you to provide such a key, in order to do background checks and, in general, maintain the security of their assets. EVE University follows that norm, and you can be assured that nobody will be able to check out everything you have and do : it is a simple measure of security, and staff only sees the relevant information for their job (mostly : is your API key working at all !)
 
Most corporations of significance in EVE will require you to provide such a key, in order to do background checks and, in general, maintain the security of their assets. EVE University follows that norm, and you can be assured that nobody will be able to check out everything you have and do : it is a simple measure of security, and staff only sees the relevant information for their job (mostly : is your API key working at all !)
  
=Step one : Go to the University's Tools=
+
==Step one : Go to the University's Tools==
 
The [http://tools.eveuniversity.org/ Tools] is the university's main third party database and administrative tool. This is where a prospective student can apply to the Uni, and where current members can request their advancement [[Titles]]. As it turns out, it's also where you can update your API key !
 
The [http://tools.eveuniversity.org/ Tools] is the university's main third party database and administrative tool. This is where a prospective student can apply to the Uni, and where current members can request their advancement [[Titles]]. As it turns out, it's also where you can update your API key !
 
First, you will have to log in using the [[lexicon#SSO|SSO]], then go to the 'Update API' tab :
 
First, you will have to log in using the [[lexicon#SSO|SSO]], then go to the 'Update API' tab :
 
[[File:Tools-homepage-updateAPI.png]]
 
[[File:Tools-homepage-updateAPI.png]]
  
=Step two : Create an API key following the proper mask=
+
==Step two : Create an API key following the proper mask==
 
In order to create your API key, you will have to go to the official CCP website using [https://community.eveonline.com/support/api-key/CreatePredefined?accessMask=799940875 this link] (also right on the tools' page)
 
In order to create your API key, you will have to go to the official CCP website using [https://community.eveonline.com/support/api-key/CreatePredefined?accessMask=799940875 this link] (also right on the tools' page)
  
Don't forget to tick the "No expiry" check box such as the API key doesn't stop working after a year (by default). This will make sure you do not have to go through this process again, unless there is a change in our required API mask (the information the API key gives access to).
+
Name: [EVE-Uni xxxx API]<br />
[[File:API-no-expiry-checkbox.png]]
+
Character: [All]<br />
 +
Type: [Character]<br />
 +
Verification Code: [generate] Click this button after all other blocks are completed, but Before clicking the SUBMIT button.<br />
 +
Expires:  [leave the date as is], [checkbox] No Expiry<br />
 +
 
 +
Don't forget to tick the "No expiry" checkbox such as the API key doesn't stop working after a year (by default). This will make sure you do not have to go through this process again unless there is a change in our required API mask (the information the API key gives access to).<br />
 +
 
 +
Below you can see the information that is requested for an E-UNI API:
 +
 
 +
[[File:Api.PNG]]
  
Now it's just a matter of validating the creation of the API key.
+
Now it's just a matter of generating the API and copying the API Key ID and verification code into the E-Uni tool.
  
=Step three : update your Tools account with the proper API information=
+
==Step three : update your Tools account with the proper API information==
 
Once this is done, your last step is to enter the correct two chains of characters securing your new API key into the tools, and validating the modification.  
 
Once this is done, your last step is to enter the correct two chains of characters securing your new API key into the tools, and validating the modification.  
 
[[File:API-key-informations.png]]
 
[[File:API-key-informations.png]]
  
  
You're done !
+
===You're done !===

Revision as of 21:14, 7 May 2018

Template:HR Navbar

20th Anniversary Eagle Logo.png This page's intent is to provide information on the the history of EVE University. The information on this page is no longer current.

What is the EVE Uni API key

The University requires every one of its members, may it be students, staff or faculty, to provide an API key. What in the name of Bob is an API key, will you ask ? Well, it is a tool CCP devised in order to allow 3rd party tools (such as EVEmon, EFT, Pyfa, Fleet-up, to name a few) to pull information from your account without being able to take any actions in your stead - in short, it allows you to give a very controlled monitoring right to a third party. Most corporations of significance in EVE will require you to provide such a key, in order to do background checks and, in general, maintain the security of their assets. EVE University follows that norm, and you can be assured that nobody will be able to check out everything you have and do : it is a simple measure of security, and staff only sees the relevant information for their job (mostly : is your API key working at all !)

Step one : Go to the University's Tools

The Tools is the university's main third party database and administrative tool. This is where a prospective student can apply to the Uni, and where current members can request their advancement Titles. As it turns out, it's also where you can update your API key ! First, you will have to log in using the SSO, then go to the 'Update API' tab : Tools-homepage-updateAPI.png

Step two : Create an API key following the proper mask

In order to create your API key, you will have to go to the official CCP website using this link (also right on the tools' page)

Name: [EVE-Uni xxxx API]
Character: [All]
Type: [Character]
Verification Code: [generate] Click this button after all other blocks are completed, but Before clicking the SUBMIT button.
Expires: [leave the date as is], [checkbox] No Expiry

Don't forget to tick the "No expiry" checkbox such as the API key doesn't stop working after a year (by default). This will make sure you do not have to go through this process again unless there is a change in our required API mask (the information the API key gives access to).

Below you can see the information that is requested for an E-UNI API:

Api.PNG

Now it's just a matter of generating the API and copying the API Key ID and verification code into the E-Uni tool.

Step three : update your Tools account with the proper API information

Once this is done, your last step is to enter the correct two chains of characters securing your new API key into the tools, and validating the modification. API-key-informations.png


You're done !