How to Generate a Data API key

Generating the API key

1. Click the Generate API Key button.

   

   Generate API Key

   
   

   
   

2. The system will create the API Key.

   
   
   

   
   

   

   API Key successfully generated

   
   

   
   

3. Click the Copy to clipboard button to copy the API key.

   
   

   WARNING! Make sure you copy the key (token) immediately. The system does not store it, so you won't be able to view it later.

   Only one active API key can exist at any given time per system. Each newly created API Key will eliminate the currently existing one.

4. Click Close.

5. Active status, Creation date, and Created by will be displayed in the API Key section of the Security tab.

   
   
   

6. Use the 'Revoke' option under Action if needed.

7. Proceed with using the generated API Key secret as described here: APIs in LearningSpace

   ---

Revoking the API key

1. Press Revoke under Action in the API Key section of the Security tab.

   

   Revoke API Key

   
   

   
   

2. A confirmation pop-up will appear. Press 'Revoke' (or 'Cancel' to quit the process).

Warning: This action will deactivate the system-wide API key.

API Key revoked

Utilizing the API key

You can use the API key to access the Data API.

Enable Data API Access