This repository has been archived by the owner on Aug 22, 2019. It is now read-only.
Issuer Checklist
Sue Smith edited this page Aug 8, 2014
·
4 revisions
When you're issuing Open Badges, there can be a lot to remember. Check out the lists below to make sure you've done everything you need to, whether you're creating a badge or awarding one.
| Required | Task | Details |
|---|---|---|
| ✔ | Badge class JSON hosted at stable location | |
| ✔ |
name field included in badge class |
text |
| ✔ |
description field ″″ |
text |
| ✔ |
image field ″″ |
url |
| ✔ |
criteria field ″″ |
url |
| ✔ |
issuer field ″″ |
url |
alignment field ″″ |
array [{ name, url and optional description },...]
|
|
tags field ″″ |
array of text values | |
| ✔ | Issuer organization JSON hosted at stable location | |
| ✔ |
name field included in issuer organization JSON |
text |
| ✔ |
url field ″″ |
url |
description field ″″ |
text | |
image field ″″ |
url | |
email field ″″ |
text | |
revocationList field ″″ |
url of JSON file: {uid:reason,...}
|
|
| ✔ | Issuer JSON file location matches badge class issuer field |
|
| ✔ | Badge image created and hosted at stable location | |
| ✔ | Badge image is square PNG or SVG | |
| ✔ | Badge image dimensions are 90px minimum | - content renders legibly at 50px |
| ✔ | Badge image file size is 256kb maximum | |
| ✔ | Badge image location matches badge class image field |
| Required | Task | Details |
|---|---|---|
| ✔ | Badge assertion created and hosted/ signed | |
| ✔ |
uid field included in assertion |
unique identifier |
| ✔ |
recipient field ″″ |
object: - identity hash or text - type "email" - hashed boolean - salt text (optional) |
| ✔ |
badge field ″″ |
url of badge class |
| ✔ |
verify field ″″ |
object: - type "hosted" or "signed" - url assertion or public key url
|
| ✔ |
issuedOn field ″″ |
datetime |
image field ″″ |
url | |
evidence field ″″ |
url | |
expires field ″″ |
datetime | |
| if signed | Assertion signed using private key | - corresponding to public key hosted at location in verify.url field |
| If hosted | Assertion hosted at stable url | |
| Badge assertion validated | - via web interface http://validator.openbadges.org/ - or programmatically https://github.com/mozilla/openbadges-validator/ |
|
| Badge baked | - via a baking service https://github.com/mozilla/openbadges/wiki/Badge-Baking | |
| Earner given opportunity to push badge to a backpack | e.g. to Mozilla Backpack via Issuer API |
Badge issuing can involve lots of other tasks depending on your project, for example, you may be using assessment, claim codes or software tools to automate parts of the process. The checklists above outline the basic issuing requirements to comply with the OBI.
If you're just getting started as an issuer, see these resources as well: