Overview

CYPHER Learning’s API allows you to integrate your learning platform with third party tools and systems that help elevate your user’s experience. The CYPHER API is the intermediary between the features of our LMS and your website or software. The API allows you to share data and trigger events that provide nearly endless automation possibilities.

The documentation found in the Administrator and Developer sections of our Help Center are designed to assist each role in the step-by-step process of enabling and creating APIs for their individual needs. Please check these pages regularly, as they will be updated as API processes and standards change. If you have any suggestions or questions regarding API, please visit our Support Forum.

API Versions

CYPHER Learning currently supports two API instances: versions 1.0 and 2.0. By default, API access to your site is disabled. To begin using API, please navigate to the Getting Started section below.

NOTE: API 1.0 will be supported until full parity with API 3.0 is achieved. For more information contact your Account Executive.

Our API 2.0 uses modern best practices which supports the Open API 3.0 specification and works with popular API invocation tools, such as Postman. This API follows the REST (Representational State Transfer) principles and is based on the following principles:

Getting Started

Click Admin, App Center.

Search for “API” in the search field.

Once you find the version of the API app you wish to use, click Install.

(Administrators: Please navigate to your designated section at this point.)

Super Administrators

As a Super Administrator, you will create API keys to be used by Administrators. You also have the ability to edit, delete, and add API keys as needed. In addition, each API key can have an optional expiry date, restricted set of IPs, and/or a restricted set of operations. This allows you to create different keys for different situations.

Create an API Key

In the API Keys tab, click Add to create a new API key.

Enter a name for the API key and select the API version you wish to use. Click Save.

Note: If you installed API 2.0, the Version field will default to that version number.

When an API key is created, it is not enabled and has no restrictions. To begin using the API key click the Enabled checkbox.

Edit an Existing API Key

To configure an existing API key, click the API key name.

You can edit the API Key name and/or the restrictions. To rename the API, click Rename.

In the Edit popup, enter the new name for the API key and click Save.

Click Regenerate key to regenerate a new secret key. This invalidates the previously used secret key.

To change the user listed in the "Executes as:" field, click Change User.

Select the user from the People Picker screen and click Select.

To change the API key's restrictions, navigate to the Restrictions area and click Edit.

First, select a date when the API key will expire. Select the Never radio button or select the At specified date radio button and select the date from the calendar.

You can also allow certain IPs. To enter a limited number of IPs, click the Specified radio button and click add. You can add as many IPs as needed in the text field.

You can also restrict the set of operations of the API key by defining its scope. To do so, click the Specified radio button under Scope.

There are a number of specifications to choose from. Review each heading and select the appropriate checkboxes.

After setting the restrictions, click Save. 

The selected restrictions will be displayed in the Restrictions area on the page of the API key.

Administrators

Administrators can see a list of the available API keys, but cannot add, edit or delete them. To request a new API key or for modifications to existing API keys, please contact your Super Administrator.

To view a list of available API Keys, click Admin and then API.

The list of available API keys displays, along with the API version number, the date it was created, the expiration date, the number of calls, and the number of errors.

To see more information about a specific API key, click the API key name.

To learn more, visit the API 3.0 Help center article.