Credly Acclaim Integration

Owned by Seth Petry-Johnson
Last updated: Apr 29, 2024
3 min read

Overview

Credly Acclaim is a digital badging platform. LearningBuilder can issue and revoke badges for Practitioners when they achieve various milestones.

Supported features

  • Badges are defined through the Credly site

  • Badges are issued via LearningBuilder’s Workflow engine

  • Expiration dates can be configured in LearningBuilder

  • License Numbers (or other data) can be attached to the badge as “ID Evidence”

  • Email notifications from Credly to the earner can be optionally sent

Configuring the Credly integration

1

Create a Badge Template in Credly’s system

In the Credly system, create a Badge Template.

image-20240429-141854.png
Creating a Badge Template in Credly
2

Record the Organization and Template IDs

Once the Badge Template is created, click on the “Developers” link in the sidebar and make note of the Organization Id and Template Id values that were assigned by Credly.

image-20240429-142740.png
Obtaining the IDs needed for the integration
3

Generate a Credly authorization token

Under the “Developers” section in Credly, click on “Authorization Tokens” and generate a new token.

Make a note of its value.

4

Configure the API Endpoint credentials

This step requires System Administrator access in LearningBuilder.

In Sys Admin → App Config, edit the RestApiEndpoints setting and define a Credly endpoint. (See the REST API Endpoints docs)

The URL contains the Organization Id, the username is the Auth Token, and the password is blank. For more details, see Credly’s web service authentication docs

{ "Name": "CredlyAcclaim", "Url": "https://api.credly.com/v1/organizations/{OrganizationId}/badges", "BasicAuthUsername": "{AuthToken}", "BasicAuthPassword": "", "HttpMethod": "POST", "Headers": { "Content-Type": "application/json" } }

For the PROD version of this setting you will use the api.credly.com domain.

For non-PROD environments you will use http://sandbox-api.credly.com instead.

5

Configure a System Template to manage the API payload

6

Configure a Workflow Attribute to hold the Badge Template Id

If you will be issuing the badge as part of a Complete Learning Plan Workflow, then use the Configure Learning Plan Workflow to enter the Badge Template Id for each Learning Plan.

If you will be issuing the badge as part of a Complete Activity Workflow, then use the Create Activity Workflow to enter the Badge Template Id at the Activity Definition level.

7

Configure a Workflow Behavior to issue the badge

Use the https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/3879731257 to issue a badge at the appropriate place in your Workflow.