README.md

BadgeKit API Documentation

The BadgeKit API docs include the information you need to get started using the endpoints and webhooks. The docs are structured as follows:

• API Endpoints
• Containers:
  • Systems
  • Issuers
  • Programs
• Badge Management:
  • Badges
    • Milestones
  • Claim Codes
  • Issuing
  • Assessment
• Webhooks
• Authorization

You can interact with badge and application data managed by the API using the endpoints. The data you send to the API endpoints needs to be signed for authentication, and the data you receive from the API (in responses and webhook messages) is signed before it is sent. To detect badging events carried out through the API, such as badges being issued/ revoked and badge applications being reviewed, you can configure a webhook URL to which BadgeKit API will send data.

The API docs provide a reference for the endpoints and webhooks. You will also find detailed guides to carrying out common processes, including the assessment flow, together with sample code excerpts, in the BadgeKit API wiki:

• Using BadgeKit API
• Retrieving Badges
• Submitting Applications
• Application Review Webhooks
• Awarding Badges
• Badge Issued Webhooks

For additional support using BadgeKit or the API, feel free to get in touch using one of the following methods:

• Post general questions in our Community Google Groups and post technical questions in our Dev Google Group.
• Reach members of the Open Badges team directly on IRC (irc.mozilla.org) on the #badges channel.
• Email questions directly to [email protected] and a member of the team will follow-up.
• Follow or tweet the Open Badges team @OpenBadges.
• Get involved or submit issues via the GitHub repos - feedback is always appreciated!