Skip to content
This repository has been archived by the owner on Sep 2, 2020. It is now read-only.

Commit

Permalink
Merge pull request #91 from mozilla/doc-updates
Browse files Browse the repository at this point in the history 
Huge number of doc updates. Thanks @SueSmith!
  • Loading branch information
@cmcavoy
cmcavoy committed Jun 6, 2014
2 parents 4a2a254 + af17220 commit 7d7cc4e
Show file tree
Hide file tree
Showing 11 changed files with 3,422 additions and 438 deletions.
36 changes: 36 additions & 0 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 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](api-endpoints.md)
* Containers:
* [Systems](systems.md)
* [Issuers](issuers.md)
* [Programs](programs.md)
* Badge Management:
* [Badges](badges.md)
* [Milestones](milestones.md)
* [Claim Codes](claim-codes.md)
* [Issuing](issuing.md)
* [Assessment](assessment.md)
* [Webhooks](webhooks.md)
* [Authorization](authorization.md)

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 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](https://github.com/mozilla/badgekit-api/wiki):

* [Using BadgeKit API](https://github.com/mozilla/badgekit-api/wiki/Using-BadgeKit-API)
* [Retrieving Badges](https://github.com/mozilla/badgekit-api/wiki/Retrieving-Badges)
* [Submitting Applications](https://github.com/mozilla/badgekit-api/wiki/Submitting-Applications)
* [Application Review Webhooks](https://github.com/mozilla/badgekit-api/wiki/Application-Review-Webhooks)
* [Awarding Badges](https://github.com/mozilla/badgekit-api/wiki/Awarding-Badges)
* [Badge Issued Webhooks](https://github.com/mozilla/badgekit-api/wiki/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](http://bit.ly/OBIGeneral) and post technical questions in our [Dev Google Group](http://bit.ly/OBIDev).
* Reach members of the Open Badges team directly on IRC (irc.mozilla.org) on the #badges channel.
* Email questions directly to [badges@mozillafoundation.org](mailto:badges@mozillafoundation.org) and a member of the team will follow-up.
* Follow or tweet the Open Badges team [@OpenBadges](https://twitter.com/OpenBadges).
* Get involved or submit issues via the GitHub repos - feedback is always appreciated!
93 changes: 52 additions & 41 deletions docs/api-endpoints.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# API Endpoints

See the following overview of the available BadgeKit API endpoints - browse to the linked docs in each section for more detailed information.

* Containers
* Systems
* [Systems](systems.md)
* **GET** /systems
* **POST** /systems
* **GET** /systems/:slug
* **PUT** /systems/:slug
* **DELETE** /systems/:slug
* Issuers
* [Issuers](issuers.md)
* **GET** /systems/:slug/issuers
* **POST** /systems/:slug/issuers
* **GET** /systems/:slug/issuers/:slug
* **PUT** /systems/:slug/issuers/:slug
* **DELETE** /systems/:slug/issuers/:slug
* Programs
* [Programs](programs.md)
* **GET** /systems/:slug/issuers/:slug/programs
* **POST** /systems/:slug/issuers/:slug/programs
* **GET** /systems/:slug/issuers/:slug/programs/:slug
* **PUT** /systems/:slug/issuers/:slug/programs/:slug
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug
* Badges
* Managing: Badges can belong directly to a system, an issuer, or a program.
* Badge Management
* [Badges](badges.md) (can belong directly to a system, issuer or program)
* **GET** /systems/:slug/badges
* **GET** /systems/:slug/issuers/:slug/badges
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges
Expand All @@ -34,10 +38,7 @@
* **DELETE** /systems/:slug/badges/:slug
* **DELETE** /systems/:slug/issuers/:slug/badges/:slug
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug
* Claim Codes
* **GET** /systems/:slug/codes
* **GET** /systems/:slug/issuers/:slug/codes
* **GET** /systems/:slug/issuers/:slug/programs/:slug/codes
* [Claim Codes](claim-codes.md)
* **GET** /systems/:slug/codes/:code
* **GET** /systems/:slug/issuers/:slug/codes/:code
* **GET** /systems/:slug/issuers/:slug/programs/:slug/codes/:code
Expand All @@ -59,10 +60,7 @@
* **POST** /systems/:slug/badges/:slug/codes/:code/claim
* **POST** /systems/:slug/issuers/:slug/badges/:slug/codes/:code/claim
* **POST** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/codes/:code/claim
* **POST** /systems/:slug/badges/:slug/codes/:code/unclaim
* **POST** /systems/:slug/issuers/:slug/badges/:slug/codes/:code/unclaim
* **POST** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/codes/:code/unclaim
* Issuing
* [Issuing](issuing.md) (badge instances)
* **GET** /systems/:slug/instances/:email
* **GET** /systems/:slug/issuers/:slug/instances/:email
* **GET** /systems/:slug/issuers/:slug/programs/:slug/instances/:email
Expand All @@ -78,7 +76,7 @@
* **DELETE** /systems/:slug/badges/:slug/instances/:email
* **DELETE** /systems/:slug/issuers/:slug/badges/:slug/instances/:email
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/instances/:email
* Assessment
* [Assessment](assessment.md) (managing earner applications for badges)
* **GET** /systems/:slug/applications
* **GET** /systems/:slug/issuers/:slug/applications
* **GET** /systems/:slug/issuers/:slug/programs/:slug/applications
Expand All @@ -88,30 +86,43 @@
* **POST** /systems/:slug/badges/:slug/applications
* **POST** /systems/:slug/issuers/:slug/badges/:slug/applications
* **POST** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications
* **GET** /systems/:slug/badges/:slug/applications/:id
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:id
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id
* **GET** /systems/:slug/badges/:slug/applications/:id/evidence
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/evidence
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/evidence
* **POST** /systems/:slug/badges/:slug/applications/:id/evidence
* **POST** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/evidence
* **POST** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/evidence
* **GET** /systems/:slug/badges/:slug/applications/:id/evidence/:id
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/evidence/:id
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/evidence/:id
* **DELETE** /systems/:slug/badges/:slug/applications/:id/evidence/:id
* **DELETE** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/evidence/:id
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/evidence/:id
* **GET** /systems/:slug/badges/:slug/applications/:id/reviews/:id
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/reviews/:id
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/reviews/:id
* **POST** /systems/:slug/badges/:slug/applications/:id/reviews
* **POST** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/reviews
* **POST** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/reviews
* **PUT** /systems/:slug/badges/:slug/applications/:id/reviews/:id
* **PUT** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/reviews/:id
* **PUT** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/reviews/:id
* **DELETE** /systems/:slug/badges/:slug/applications/:id/reviews/:id
* **DELETE** /systems/:slug/issuers/:slug/badges/:slug/applications/:id/reviews/:id
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:id/reviews/:id
* **PUT** /systems/:slug/badges/:slug/applications/:slug
* **PUT** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug
* **PUT** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug
* **GET** /systems/:slug/badges/:slug/applications/:slug
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug
* **DELETE** /systems/:slug/badges/:slug/applications/:slug
* **DELETE** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug
* **GET** /systems/:slug/badges/:slug/applications/:slug/reviews
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug/reviews
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug/reviews
* **GET** /systems/:slug/badges/:slug/applications/:slug/reviews/:slug
* **GET** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug/reviews/:slug
* **GET** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug/reviews/:slug
* **POST** /systems/:slug/badges/:slug/applications/:slug/reviews
* **POST** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug/reviews
* **POST** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug/reviews
* **PUT** /systems/:slug/badges/:slug/applications/:slug/reviews/:slug
* **PUT** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug/reviews/:slug
* **PUT** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug/reviews/:slug
* **DELETE** /systems/:slug/badges/:slug/applications/:slug/reviews/:slug
* **DELETE** /systems/:slug/issuers/:slug/badges/:slug/applications/:slug/reviews/:slug
* **DELETE** /systems/:slug/issuers/:slug/programs/:slug/badges/:slug/applications/:slug/reviews/:slug
* [Milestones](milestones.md)
* **GET** /systems/:slug/milestones
* **POST** /systems/:slug/milestones
* **GET** /systems/:slug/milestones/:milestoneId
* **PUT** /systems/:slug/milestones/:milestoneId
* **DELETE** /systems/:slug/milestones/:milestoneId

See also [authorization](authorization.md) and [webhooks](webhooks.md).

<!--
* **GET** /public/systems/:slug
* **GET** /public/systems/:slug/issuers/:slug
* **GET** /public/systems/:slug/issuers/:slug/programs/:slug
* **GET** /public/assertions/:slug
* **GET** /public/images/:imageId
-->
Loading

0 comments on commit 7d7cc4e

Please sign in to comment.