Using the Displayer API
This guide is currently being redrafted - be done soon!
With the Displayer API, you can query the Mozilla Hosted Backpack for public badges awarded to a particular earner. See the documentation for a technical overview and for a step-by-step tutorial to using the API, read on.
Earners can use their Mozilla Backpack to organize their awarded badges into groups and to control whether or not a group of badges is publicly available. Given the earner's email address for the Backpack, you can query for the groups of badges they have made public, displaying these within your own site, application or widget.
To display earner badges, you will need to parse assertion data. If you are new to assertions, see these pages first:
- Converting Email to ID
- In the Browser
- In Code
- Querying for Badge Groups
- Querying for Badges in a Group
To discourage storing earner email addresses explicitly, the Mozilla Backpack instead uses a unique ID for each earner. You can pass the earner email address to the convert service to retrieve their Backpack user ID - which you can then use to make Displayer API calls.
You can use the conversion service manually in your Web browser, using cURL in a terminal or in your application code.
To convert an earner email address to Backpack user ID in the browser, visit:
http://backpack.openbadges.org/displayer/convert/email
Enter the earner email address to convert to their ID - copy the returned ID to use in your Displayer API calls.
coming soon
coming soon
coming soon