Requesting preauthorization to connect with Canvas Badges

If your institution's Canvas server is hosted by Instructure, most likely, you'll automatically be approved to connect to our Canvas Badges servers in any location when you add the LTI.

Some Instructure-hosted Canvas instances may need to be manually authorized.

If, after adding the Canvas Badges LTI to your course, sub-account or account, you see an error message like the one below, email us [email protected] Canvas server URL (e.g., myschool.instructure.com).

If you see the message below, please provide the URL as it appears in the message.


Beta and test installations

Requesting preauthorization to connect with Badgr

If you'd like to see how the badge-issuing process works before integrating with your production server, you can integrate Canvas Badges with an Instructure-hosted Canvas beta or test installation. For more information, see Instructure's What is the Canvas release schedule for beta, production  and test environments?

Requesting to connect a self-hosted Canvas server

If your institution hosts its own server, connecting Canvas Badges to the Canvas application is easy.

In order to connect Canvas Badges to a self-hosted Canvas installation, we require your site to have an SSL certificate. Next, you'll need to create a developer key and then send us your ID, secret Key string and Canvas server URL. Canvas Badges uses the developer key to sign OAuth 2.0 http://oauth.net/2/ requests so that teachers can connect to their Canvas Badges accounts and issue badges to students — and our application can be securely identified by your server.

Creating a developer key is a one-time set-up process, after which any instructor on your instance of Canvas can add Canvas Badges as an LTI, or an administrator can add Canvas Badges across a whole account or sub-account.

For more information, see Instructure's How do I add a developer key for an account?

  1. As an administrator, navigate to the managed account for which you would like to create a developer key
  2. In the left menu, select Developer keys
  3. Click the Add developer key button
  4. In the dropdown menu, select +API key.
Requesting to connect a self-hosted Canvas server
  1. Create a new developer key for Canvas Badges with these suggested settings (only the Redirect URI is essential)
  2. Key name: Canvas Badges
    Owner email: <your email>
    Redirect URI (Legacy): https://api.Canvas Badges.io/ https://api.Canvas Badges.io/
    Redirect URI: https://api.Canvas Badges.io/ https://api.Canvas Badges.io/ (<- optional)
    Icon URL: https://api.Canvas Badges.io/static/images/logo.png https://api.Canvas Badges.io/static/images/logo.png

If you are connecting to a server outside the US (AU, EU, CA), please include the country code in the URI (e.g. https://api.eu.Canvas Badges.io/ https://api.eu.Canvas Badges.io/)

If you see {“error”:“invalid_request”,“error_description”:“redirect_uri does not match client settings”}, please leave the Redirect URI field blank, but include the Legacy URI. Additionally, if you are still experiencing issues please try the following http://api.eu.Canvas Badges.io/badgebook/oauth2/return http://api.eu.Canvas Badges.io/badgebook/oauth2/return in the Legacy URI field.

Requesting to connect a self-hosted Canvas server

Sending your ID, key and URL

Be sure to select the entire field when copying the information.

  1. Once you've created a developer key for Canvas Badges, select Details on the Developer keys page.
  2. Email us [email protected] Badges.com with your developer ID, secret key string and Canvas server URL.
  3. The key string will be hidden by default until you mouse over it.
  4. Canvas only displays about 20 characters of the key string, but it is 64 characters long for self-hosted instances (typically).
  5. Once we confirm your installation is connected to Canvas Badges, you and other Canvas instructors will be free to add Canvas Badges to courses.