Requesting Preauthorization to connect with Badgr

Requesting Preauthorization to connect with Badgr

Most Instructure-hosted Canvas instances are automatically authorized

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

 

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

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


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


Beta and Test installations 
If you'd like to see how the badge-issuing process works before integrating with your Production server, you can also integrate Badgr 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

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?
  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



      5. Create a new Developer Key for Badgr with these suggested settings (only the Redirect URI is essential)

  1. Key Name: Badgr
    Owner Email: <your email>
    Redirect URI (Legacy): https://api.badgr.io/  
    Redirect URI: https://api.badgr.io/   (<- optional)
    Icon URL: https://api.badgr.io/static/images/logo.png   


If you are connecting to a different server, please include the country code in the URI (e.g. https://api.eu.badgr.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.badgr.io/badgebook/oauth2/return in the Legacy URI field.

key and secret

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 Badgr, select Details on the Developer Keys page, email us with your Developer ID, secret Key string, and Canvas server URL. 
    1. the Key string will be hidden by default until you mouse over it. 
    2. Canvas only displays about 20 characters of the key string, but it is 64 characters long for self-hosted instances (typically).
  2. Once we confirm your installation is connected to Badgr, you and other Canvas instructors will be free to add Badgr to courses.

 


    • Related Articles

    • How to get a Consumer Key and Shared Secret

      A Consumer Key and Shared Secret is needed to connect Canvas to  Badgr To get a Consumer Key and Shared Secret 1. Create an account at one of the Badgr servers below using the same email address as your primary Canvas ID. For the best experience, we ...

    • Adding the Badgr LTI to Canvas

      The process for installing Badgr at the course, sub-account or root level are similar. Most users choose to install Badgr at the sub-account or root level of their Canvas instance.  Installing Badgr at the sub-account or root level will: Enable Badgr ...

    • XML for Canvas

      We've provided some custom XML so that Canvas admins may accomplish several different things in Canvas. With our XML you may: Install Badgr so it is hidden in Canvas courses by default. Use the XML to install Badgr at the root level so that it is ...

    • Checklist for badging in Canvas courses

      Once you've completed these steps, you're all set to configure Badgr to award Open Badges automatically in your course.  If you are outside the US, please ensure that you are using your regional server (Australia, Canada or Europe). You will need to ...

    • Badgr Pathways LTI for Canvas

      Prerequisites Ensure you are enrolled as a teacher in the Canvas course. You need to define an issuer in Badgr before creating the Badgr Pathway. You will need to create the Badgr Pathway prior to installing the LTI. You can add the Pathway LTI to ...