This document is meant for use by Cerego’s partner organizations.
Integrating Cerego into an LMS is an easy process, in order to do this you will need to:
- Lookup your Oauth Client Key and Secret
- Configure Cerego as an External Tool within your LMS
- Configure your LMS to use the Cerego LTI endpoints
- This may vary depending on your LMS and how your assignments are configured
- (optional) Use custom launch parameters to fine tune Cerego grading parameters
Lookup or create your OAuth Client
Step 1: Navigate to Cerego Admin
In order to integrate Cerego with your LMS via LTI, you must sign your requests to Cerego with a secret key. To get this secret key, go to your Admin in the side navigation area, and then select Account Set-up.
If you don't have this option, you may not have correct permissions to manage your Partner account. Only "Owners" of an account can configure Oauth Clients. Contact your Sales representative in order to get the correct permissions.
Step 2: Navigate to Oauth Settings Tab
Step 3: Configure Client Parameters
The exact values here are more of a formality since LTI will actually use a custom Oauth integration will ignore most of these. You may create as many clients as you like, there is no limit within Cerego.
Step 4: Find your Key And Secret
Once your client is created, we will generate an OAuth Key and OAuth Secret for you, these will be needed within your LMS in order to add Cerego as an External Tool. Do NOT share your secret with anyone else, as it is used by Cerego to trust and authenticate requests from your LMS.
LTI Endpoints:
LTI endpoints are accessible over SSL with an HTTP POST request, please refer to the IMS LTI specification for details on how to construct and sign your LTI request. If you are using an LMS, most of these will already be set for you.
https://www.imsglobal.org/specs/ltiv1p1/implementation-guide
We support embedding the learning experience of a set via LTI. The endpoint for a set can be found on its set detail page, and will follow the format of /lti/study/:id
Example LTI Endpoint:
If you would like to configure your LMS to embed the Insider's Guide to Napa Valley, found at: https://cerego.com/create/sets/731767
You would configure your LMS with the following endpoint:
https://cerego.com/lti/study/731767
If your LMS does not support configuring different endpoints per assignment, you can also use:
With the custom launch parameter: custom_set_id=731767
Environments:
Cerego provides you with access to our Production instance, as well as to a QA environment. Please note that the QA environment is reset every Sunday and will revert to the same data as production.
|
URL |
Notes |
|
https://cerego.com |
Production - this is the main URL that you should use within your LMS |
|
https://stable.cerego.com |
QA - please note that there may be new features available on testing that are not yet available on production, feel free to point your own QA environment here, keeping in mind that any changes are not guaranteed to persist longer than a week. You may use your production Oauth key & secret, though if you wish to have a separate key that is also OK. |
LMS Specific Documentation:
Canvas
https://docs.google.com/presentation/d/1mJw11vcbCIfCt246avyaA9pZf8oHetfTAlIlkKdLYfA/edit?usp=sharing
Full List of supported LTI Parameters:
|
Parameters |
Value |
Notes |
|
id |
Set ID |
Optional, used to specify the set ID |
|
context_id |
Course ID |
Required |
|
context_label |
Course Name |
Optional, used in naming courses |
|
context_title |
Course Name |
Required, used in naming courses |
|
custom_set_id |
Set ID |
Optional, required if not specified in endpoint URL |
|
custom_scoring_target |
Float from 0.0 to 4.0 |
Optional, if provided used to set target set level for grading |
|
custom_scoring_type |
“progress_to_score” |
Optional, if provided must be set to “progress_to_score” |
|
lis_outcome_service_url |
URl |
Optional, if provided lis_result_sorcedid is required |
|
lis_result_sourcedid |
Unique Assignment ID |
Optional, if provided lis_outcome_service_url is required |
|
lis_person_contact_email_primary |
|
Optional, but strongly encouraged |
|
lis_person_name_family |
Name |
Optional |
|
lis_person_name_given |
Name |
Optional |
|
lis_person_name_full |
Name |
Optional, if provided lis_person_name_family and lis_person_name_given are ignored |
|
lti_version |
LTI Version |
Required |
|
lti_message_type |
LTI Message Type |
Required |
|
roles |
LTI Role |
Required |
|
user_id |
Unique ID |
Required, the unique ID for the user from your system |
|
oauth_consumer_key |
OAuth Key |
Required |
|
oauth_signature_method |
OAuth Signature Method |
Required |