This covers the contract between the Game application and the BadgeOS system implemented as a plugin within WordPress.
BDG-00: User
Badging begins with identifying the User Accounts — identified by an Email Address — that will be awarded badges. There are a set of Use Cases for User Admin (Maintain User UCs) which provide context for the User API between BadgeOS and the ClueRide Server.
This page is specific to the API for BadgeOS Users, which is a specific system-to-system API between ClueRide Server and the BadgeOS system.
BadgeOS User API Design goes into more implementation detail.
- BDG-00: Establish Session describes what is required to connect to BadgeOS for the exchange of information.
- BDG-01: Retrieve Users matching pattern supports USAD-02: Get List of Users
- BDG-02: Retrieve full list of User Email addresses supports synchronizing accounts
- BDG-03: Retrieve BadgeOS Principal - Get BadgeOsPrincipal given the EmailPrincipal supports maintaining links between the ClueRide account accumulating Badge Events and the Badging entities represented within BadgeOS.
Future:
There may be some fields that come into the ClueRide system that we want to propagate into the WordPress record:
- Profile Image URL
- Website URL
The synchronize API would expand on the API described here.
Related Use Cases:
BDG-10: Badge Display
There are a few related ways that a user can see what badges they have earned. BDG-11 and BDG-12 are the two that are supported by this API.
- BDG-11: (Display) Recent Badges - Summary-level for mobile "home" page.
- BDG-12: In-game Display Badges - List of Badges for mobile.
- BDG-14: Notify Badge Award - SSE push event for notifying user of new Badge Award.
- BDG-16: Badge Detail - Detail Page for a given Badge on WordPress.
- BDG-17: Badge History - List of Badges as presented in Word Press.
- BDG-18: Badge Publish and Link - Using external systems such as Credly.
BDG-20: Progress and Criteria
BDG-30: Send Event
BDG-60: Maintain Badges
- BDG-60: Maintain Badges Manual Use Cases for setting up Badges
- For testing, it's good to be able to clear the badge history. See Clearing Badge History Manually.
Diagram
Reference
Future
- Future: Can I create a BadgeOS User from the credential information I capture with my Auth0 implementation?