Before Badgr may be used on your Canvas server, you must be pre-approved by Badgr staff. This page will show you how to request authorization to connect your server to Badgr for the first time.
Instructure-hosted Canvas servers
What we need
If your institution's Canvas server is hosted by Instructure, you will only need to email us your Instructure-hosted Canvas server URL (e.g., "myschool.instructure.com") to integrate Badgr.
Beta and Test installations
You can also request that Badgr be integrated with an Instructure-hosted Canvas Beta or Test installation, if you'd like to see how the badge-issuing process works before integrating with your Production server. For more information, see Instructure's What is the Canvas release schedule for beta, production, and test environments?
Requesting to connect a server hosted by Instructure
If you use Instructure's cloud hosting for Canvas, requesting authorization to use Badgr is easy! We'll just need to know your Canvas server URL to get started. Email us your URL (e.g., "myschool.instructure.com") to request authorization.
Requesting to connect a self-hosted Canvas server
Connecting a server that your institution hosts itself using the open source Canvas application is also easy.
In order to connect Badger to a self-hosted Canvas installation, we require that your site has an SSL certificate. Then, you will need to create a Developer Key and then send us your ID, secret Key string, and Canvas server URL. Badgr uses the Developer Key to sign OAuth 2.0 requests so that teachers can connect to their Badgr account 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 Badgr as an LTI app to a course, or an administrator can add Badgr across a whole account or sub-account.
For more information, see Instructure's How do I add a developer key for an account?
- As an administrator, navigate to the managed account for which you would like to create a Developer Key
- In the left menu, select Developer Keys
- Click the Add Developer Key button
- Create a new Developer Key for Badgr with these suggested settings (only the Redirect URI is essential)
Key Name: Badgr
Owner Email: <your email>
Redirect URI (Legacy): https://api.badgr.io
Redirect URI: https://api.badgr.io
Icon URL: https://api.badgr.io/static/images/header-logo-120.png
Sending your ID, Key, and URL
- Once you've created a Developer Key for Badgr, select Details on the Developer Keys page
- Email us with your Developer ID, secret Key string, and Canvas server URL
- the Key string will be hidden by default until you mouse over it
- Canvas only displays about 20 characters of the key string, but it is 64 characters long for self-hosted instances (typically)
Be sure to select the entire field when copying the information.
- Once we confirm your installation is connected to Badgr, you and other Canvas instructors will be free to add Badgr to courses.
Need more help? Contact us at firstname.lastname@example.org