Email Support

IconCourse Toolkit API  


The Course Toolkit Application Programming Interface (API) enables you integrate your course with an existing website and/or applications.

Note: this feature is intended for software developers only. Enabling the API allows access to your account and users - we recommend disabling it if you do not wish to use it, and regularly updating your API key with a secure password in order to keep your account data secure.

Enabling API Access

To use the API, you must first enable API access and specify an API key, or password, in your account settings:

  1. Sign in to your Course Toolkit account
  2. Click the Settings tab
  3. Choose the 'API Access' option and enable/disable API access. If you want to use the API, specifiy a secure API key (password)

API Access

Once you have enabled your API, you can access it via a POST request to the following URL:

http://www.coursetoolkit.com/api

Required Fields

Field name:Value
api-userYour account ID (e.g. 523098). This can be found in the Settings tab.
api-keyYour account API key as specified in your account settings.
api-actionThe action name for your API request.
OtherOther API request-specific values

Response

The API response is formatted as an associative JSON array.

Field name:Value
responseResponse status code (0 = Success)
response_descriptionAn explanation of the response error (where applicable)
OtherOther request-specific values

API Functions

You can call any of the following API functions using the api-action field:

remove-user-permissions
Removes user.
Requires: userid (ID of the user)
create-user-permissions
Creates a new user if user doesn't exist.
Requires: email (email address of the new user)
user-details
Returns details of a user including line-separated course permissions in format "COURSEID PERMISSIONS" where PERMISSIONS is 'all' for full course access or comma-separated individual module IDs
Requires: userid (account number of the user)

    Get Started for Free

    Sign up to Course Toolkit LMS to create and publish your course in minutes:

    Choose your account name
    Use this email address to sign in
    8-12 alphanumeric characters

    By signing up, I confirm that I have read and accept the Terms of Use and Privacy Statement.