Open Badges DirectorySeptember 2014

What is it?

• Created during the Discovery project• Community resource • Storage & retrieval (API) of badge

classes

How can the directory be used?

• Third-party apps and badge search• Integrate into your badge system or

website • Research

Examples

• http://directory.openbadges.org/examples/browser/#/recent

• http://achievery.com/discover

What Badge Data Can be Retrieved?

• Initial Prototype Release:– Badge Class & IssuerOrganization – Extensions & Endorsement

specification (Once they rollout)

Also any additional fields included in either the Badge Class or IssuerOrganization.

Let’s Look at the Standard: Badge Class

• name: The name of the achievement (required)• description: A short description of the achievement (required)• image: URL of an image representing the achievement

(required)• criteria: URL of the criteria for earning the achievement

(required)• issuer: URL of the organization that issued the badge. Endpoint

should be an IssuerOrganization (required)• alignment: List of which educational standards this badge aligns

to• tags: List of tags that describe the type of achievement

example: https://app.achievery.com/badge-class/1221

Let’s Look at the Standard: Issuer Organization

• name: The name of the achievement (required)• url: URL of the institution (required)• description: A short description of the institution• image: An image representing the institution• email: Contact address for someone at the

organization

example: https://app.achievery.com/badge-issuer/1221

Let’s Look at the Standard: Extensions & Endorsements

• A way to extend the information/data in a badge• Uses an external specification• Can and is encouraged to be shared by many - if popular

could be adopted into the standard• Examples: – Endorsements– Location– Age Target– Difficulty – Apply Link

• Just like any other information in a badge, this info will be searchable

Submitting Badge Classes to the Directory

Issuers register a url that contains a list of badge classes. This list looks like:

{ "badgelist": [{ "location": "http://my-site.com/location-of-badge" }, { "location": "http://my-site.com/location-of-other-badge" }]}

Register the url at: http://mozilla.github.io/openbadges-directory/#addbadges

API - Get the Badges!

• /search– text– tags– name– issuer

• /recent• /tags

Try it out:http://directory.openbadges.org/developers/api-explorer#!/search/search

Directory - THE FUTURE

• Badge Instances• Endorsements• Pathways

Get Involved!

• Register your badges• Use the API on your websites• Badge Alliance Directory Working Group– Meets every other Thurs at 1pm ET– http://wiki.badgealliance.org/index.

php/Directory_Working_Group• Share your expertise and coding skills

Resources

• Help Pages– http://directory.openbadges.org

• Repo:– https://github.com/mozilla/openbadges-directory

• Node Client Library– https://github.com/jpcamara/openbadges-directory-client

• PHP & Rails client libraries coming soon

Questions & Feedback: • directory-support@badgealliance.org• openbadges-dev@googlegroups.com