How to access your eduMe API Key

Learn how to create and access your API key within the eduMe admin panel.

What's Covered

What are API Keys? 

How to create your API Key

How to retrieve your API Key

 


What are API Keys? 

API keys give you access to the eduMe API so that you can carry out tasks like create or update a user, or generate reports for teams or individuals. 

You can access your active API keys and create new API keys in the admin panel.


How to create your API Key: 

  1. Head to admin.edume.com and sign in
  2. Click on the Settings icon in the top left hand corner
  3. Click on Company settings
  4. In the settings list, head to API Key
  5. Click on + Create API Key
  6. Decide which access level will be granted
    1. Company level: access to the full company
    2. Group level: restricted to a single-group level
  7.  Click Create API Key and you are good to go!

Your new API Key will appear in the API Keys list along with your other active ones. You can copy the key as well as delete them. 

💡An eduMe API key has this format:

          xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

  • example API key: 1234abcd-efg5-6hij-klm7-8910nopqr123

How to retrieve your API Key:

  1. Follow steps 1-3 from above
  2. In the same settings list as before, head to API Key

There you will find the API keys that are currently active for your company as well as being able to create an API Key.