The HelioCampus Assessment Badge API is designed based on (and extends) the Open Badges 2.0 standards defined by IMS Global. The implemented extensions, enables API clients to create well-defined badges with minimum required data; the required metadata for a badge can be found here.
HelioCampus provides the below Badge API endpoints to support (and extend) the minimum required functionality.
Badge Endpoints
-
Create or Update a Badge
-
Read a Badge
Assertion Endpoints
-
Create an Assertion
-
Read an Assertion
-
Revoke an Assertion
Authentication is required to use the Badge API. The API endpoints are not accessible without a valid JWT (JSON Web Token). A JSON web token (JWT) is a JSON Object used to securely transfer authentication information over the web. The authentication server endpoints can be accessed via:
-
https://<hostname>/auth/realms/<realmname>/.well-known/openid-configuration
To be able to complete the authentication, the following is required:
-
Client Id
-
Client Secret
-
Token Endpoint Hostname
The "token_endpoint" in the result is the endpoint that will assist with obtaining a valid JWT.
Sample Request
Sample Response
Once the bearer token is obtained, the API calls can be made by adding the token to the header. If the "Authorization" header is not included along with the bearer token, the API returns 401 Unauthorized as shown below.
📔 Additional Resources