Canvas Integration Guide
Key Points:
- Approximate setup time is 10 minutes.
- Once Admin integrates Rumi in Canvas, all Instructors will have access to Rumi.
- To use Rumi in Canvas, classes and assignments must be created in Canvas, not Rumi.
- This is a single-sign on integration, you should not register new accounts on Rumi.
- Important: For steps 4 and 13, you may need to replace app.rumiessay.com with one of the following subdomains. Please contact support@rumidocs.com in advance to confirm which subdomains you should use. The available subdomains are:
- Schools in the east coast
- us-east-1.rumidocs.com
- us-east-2.rumidocs.com
- Schools in the west coast
- us-west-2.rumidocs.com
- app.rumiessay.com
- Schools in the east coast
Step 1. Open Canvas → Click on Admin → CANVAS.
Step 2. Scroll down and click on “Developer Keys”, then click on “+ Developer Key”.
Step 3. Click on “+ LTI Key”.
Step 4. Click on “Paste JSON” then paste the JSON file from this link, and name the key "Rumi Key" and add the following email address "support@rumidocs.com".
Step 5. After creation of the key, switch the "State" to "On". Then copy the "Client Id", this is needed for Step 8 and Step 10.
.png)
.png)
Step 6. Click on Settings (left menu) → Then click on Apps (top menu).
Step 7. Click on “+ App” within Apps Tab. You may need to click on “View App Configurations” first.
Step 8. Choose by Client Id and paste the "Client ID" copied in Step 5.
Step 9. Then Click on the Settings button and click on "Deployment Id" and copy the Deployment Id, this is needed in Step 10.
Step 10. Make note of the following details (or draft an email to support@rumidocs.com —but do not send it yet). You’ll need to email us this information and API key information in the final step (Step 16).
- Client Id in Step 5
- Deployment Id in Step 9
- Canvas URL of your institution
- Canvas Launch Environment e.g. prod, beta, test, etc.
Step 11. Now click on “Developer Keys” again, then click on “+ Developer Key”.
Step 12. This time, click on “+ API Key”.
Step 13. Fill out the form using the following info
Note: You must know which subdomain you should use, if you are using app.rumiessay.com use the endpoint below, if not replace the app.rumiessay.com with the subdomain provided to you by support@rumidocs.com
- Enter a Key Name, for example “Rumi LTI"
- In the “Owner Email” section, enter “support@rumidocs.com”
- In the “Redirect URIs” section paste the following Redirect URI:
https://app.rumiessay.com/api/v1/canvas/redirect_uri - In the “Icon URL” section paste the following:
https://rumi-public-files.s3.us-west-2.amazonaws.com/assets/Rumi+Logo.png - Leave “Redirect URI (Legacy)”, “Vendor Code (LTI 2)”, “Notes” sections empty
- In the “Client Credentials Audience” section, choose “Canvas”
Click “Save”
Note: If you wish to "Enforce Scopes", you may use the scopes listed here. You must let us know that you have enforced these scopes for your integration.
Step 14. Click on “Show Key” and store the Shared Secret, it will be used in Step 16.
Step 15. Enable the key by clicking on “ON”. Store the Consumer Key, it will be used in Step 16
Step 16. Please send an email to support@rumidocs.com with the information below and LTI 1.3 data noted in Step 10:
Now follow the Guide for Instructor to add Rumi to an assignment
Key Points:
- Approximate setup time is 3 minutes.
- Your Admin must have already integrated Rumi into Canvas.
- To user Rumi in Canvas, classes and assignments must be created in Canvas, not Rumi.
- This is a single-sign on integration, you should not register new accounts on Rumi.
Step 1. Open Canvas → Click on Courses.
Step 2. Go to the “Assignments” section for a course and create a new assignment, or select an existing assignment if you already have one.
Step 3. In the “Submission Type” select “External Tool” and click the “Find” button next to the text field.
Step 4. In the dialog choose Rumi, then click on Select. Do not check the "Load in new tab" if you wish to use the embedded version of Rumi.
.png)
Step 5. Complete the rest of the Assignment Creation form and press “Save” or if the assignment hasn’t been published yet press “Save & Publish”.
Step 6. Now students will see a section that redirects them to Rumi.
Note. IMPORTANT: Tell students to do all their writing in Rumi’s Editor, THEY SHOULD NOT use another editor (i.e. Google Docs or Word) to write their essay then paste in Rumi.