Pre-requisites:
The user needs admin permissions to create the Developer Keys
Creation of Developer API Key
Go to the Admin in the Account that you want to create the keys
Go to “Developer Keys” link, go to “Add Developer key”, then “API key”
Fill in the form similar to the screenshot:
Key Name: Kira API Key
Owner email: Email of the Canvas Admin
Redirect URLs: https://app.kira-learning.com/api/auth/callback/canvas
Client credentials Audience: Canvas
Enforce scopes: Keep it disable
If the option doesn’t exists please save the key and open it again.
Select Canvas as Client Credentials Audience
Save the Key
In the next screen you are going to have clientId (black out) and Secrets (Show key) in the Details column. Those are the keys you need to share with Kira team
Creation of Developer LTI key.
Go to the Admin in the Account that you want to create the keys
Go to “Developer Keys” link, go to “Add Developer key”, then “LTI key”
Fill the form similar to the screenshot:
Key Name: Kira LTI App
Owner email: Email of the Canvas Admin of the company
Redirect URLs (different lines):
Method: Manual entry
Tittle: Kira LTI Key
Description: LTI key for SSO bridge
Target Link URI = https://app.kira-learning.com/api/lti/launch
OpenID Connect Initiation Url: https://app.kira-learning.com/api/lti/login
JWK Method: Public JWK URL
Public JWK URL: https://app.kira-learning.com/api/lti/jwks
LTI Advantage services:
Can view LTI registrations associated with the tool.
Can view assignment data in the gradebook associated with the tool.
Can view submission data for assignments associated with the tool.
Can retrieve user data associated with the context the tool is installed in.
Can lookup Account information.
Can view Progress records associated with the context the tool is installed in.
Can view the content of a page the tool is launched from
Suggested placements:
Account navigation: Target link URL https://app.kira-learning.com/api/lti/launch
Course navigation: Target link URL https://app.kira-learning.com/api/lti/launch
Save the Key
In the next screen you are going to have clientId and secrets in the Details column.
We recommend to run Kira in a new tab. In order to do that we need to come back to the LTI configuration. Open the edit in the pencil icon, go to Method and choose Paste JSON.
Add to every placement the attribute "windowTarget": "_blank",
Save it
App installation
Copy the client ID of the LTI key
Go to “Settings” → “Apps” → “+App”
Click on “By Client ID”, Paste the clientId of the LTI Key
Submit and Install
After submitting the
Collection of the keys
Reach your customer success contact and give the following information
Developer API clientId and secrets created above
Developer LTI clientId
Canvas endpoint of your school. This is usually the URL used to login into canvas