/ /

API Management Center

Updated 18 days ago

Overview

This article details how to create an API Key, view existing API's, and deactivate keys.

 

Notes about the API Key and Secret

  • The API Key can be whitelisted and able to access data from individual courses or the whole institution in NovEd. The API Key and Secret can also be used to get private user information from NovoEd and write data to a customer's instance. The API Key and Secret are as powerful as a Super Admin or Org Admin role in regards to the level of access it may provide to user information.

  • Customers can choose to make the API Key and Secret more secure by enabling a dedicated set of IP addresses to use them. If you prefer to define IP addresses, please notify the NovoEd Support Team: hello@novoed.com.

 

Creating an API Key

  1. As an Org Admin select the Admin Tools on the left hand side navigation.

  2. Select Advanced Settings.

  3. Select the Integrations tab.

  4. Below the integrations tab, select Developer tab.

  5. Select the NovoEd API card, then Create Key.

  6. Select if the key should be linked institution wide or course-wide.

  7. After, a Success banner stating your key was successfully created will appear.

  8. Your Key and Secret will appear once created.

*Please note: This is the only time you will be able to view your key and secret. Please copy and keep it in a safe place.

View and Deactivate Existing Keys:
In the NovoEd API card it will also list all existing keys. Here you can deactivate a key when an integration is retired or access is no longer needed.

Walkthrough:

Create and Manage an Organization API Key.gif

Troubleshooting

  • Make sure the key and secret are valid. Customers will receive a 401 error if they are not.

  • Make sure calls are being made from an IP address that is authorized to use the key and secret. A 401 error will also be received here if they are not. 

  • Make sure a JSON call is being made. This can be done by adding .json to the end of the endpoint before starting to pass the parameters. If the wrong request type is made or HTTP is being requested instead of JSON, an error page will show.

Was this article helpful?
Subscribe to receive updates on this article