Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API Hostnames

...

nameCertRegistryApiHostnamesAndAuth

...

Environment

...

Hostname

...

PROD

...

lb-prometric.learningbuilder-api.com TODO - UPDATE

...

TEST

...

The Learning Hub is a data sharing platform that is independent from LearningBuilder. It connects organizations that publish event data (such as a Practitioner completing a course) to the organizations that want to consume that data (e.g. to satisfy application requirements).

Table of Contents

Overview

The organizations that participate in the Learning Hub are identified as Publishers or Subscribers.

  • Publishers put data into the hub.

  • Subscribers pull data out of the hub and do something with it.

...

The primary benefits of the Learning Hub are:

  • Publishers and Subscribers do not call each other’s APIs directly, ensuring that they cannot adversely impact the performance of the other party’s systems;

  • Standard APIs make it easier to integrate with LearningBuilder by reducing or eliminating custom code.

Info

The Learning Hub is NOT specific to LearningBuilder! It can also be used to import data from a 3rd party system into LearningBuilder, or to export data from LearningBuilder out to a 3rd party system.

Development guides

For instructions on how to get started with an integration, see these links:

Calling the APIs

The Learning Hub exposes multiple APIs for different tasks. Those are listed in the following section.

All of the APIs share a common hostname and authentication system.

API Hostnames

...

Info

For help calling these endpoints, see the Postman workspace <--- TODO

...

Authentication

System administrators: see /wiki/spaces/~499343847/pages/3715269677

Endpoints in this API use one of two different authentication methods, which are documented in the individual API pages.

Method

Explanation

Handy status macro
set36399
isLabeledfalse
historySnapshotId9306c6de-e1ae-44e6-9505-1a389454e71b
status185952
historyChainId06a50fca-cffb-4e87-a2d5-1da3fcb525a0

An AWS access/secret key used by system administrators for system configuration and provisioning when API Keys may not be configured yet.

When using Postman, pass these as an AWS Signature

Handy status macro
set36399
isLabeledfalse
historySnapshotIdac74f399-bd5a-4c94-85f2-fa2f46fde05c
status185953
historyChainId06a50fca-cffb-4e87-a2d5-1da3fcb525a0

Credentials assigned to a specific user or client, consisting of a userId and an apiKey. These are assigned during client onboarding.

userId and apiKey should passed using Basic Authentication

Code Block
{Base64EncodedCredentials} = BASE64(userId + ":" + apiKey)
Authorization: Basic {Base64EncodedCredentials}

API Documentation

API

Purpose

Event Store API

Allows Publishers to put data into the Hub, and to view their data already in the Hub.

Event Subscription API

Allows Subscribers to get data out of the Hub.