The Content API allows clients to search, export and get launch links for licensed courses.

Getting Started

To get started you will need to contact your BizLibrary Client Success Manager. The BizLibrary team will configure and provide the two items that you will need to interact with the API. Technical Support will request a contact name and email address for the API Key issued.   

Technical Support will give you:

1. Billing ID
2. API Key

* You have more than one Billing ID given to you as content licensing requires.

API Endpoint/URL

https://content-api.bizlibrary.com/latest/

Technical Documentation

The technical documentation is located at: https://content-api.bizlibrary.com/latest/about/index.html#/

References:

https://wiki.apache.org/solr/CommonQueryParameters

The documentation is publicly available. It contains a way that you can try the Content API without writing any code once you have your Billing ID and API Key.

Base Data Format

The Content API uses the JSONAPI (http://jsonapi.org/) format. Common JSONAPI implementations are available (http://jsonapi.org/implementations/).

Security & Throttling

Controlling Access

Security to the Content API requires you to supply your API Key as the “x-api-key” header value.

API Rotation

We rotate API Keys based on internal security policies and needs. Our Technical Support team will notify you 15 days in advance of a required key rotation.

Service Limits

BizLibrary monitors and limits requests per day, throttles request rates per second, and allows a

burst rate requests at a higher level. If you run into errors due to throttling, please contact our

Technical Support team (support@bizlibrary.com) for assistance.

Content Lifecycle Events

› Production Date (production_date) – when the content was created by the producer

› Release Date (release_date) – when the content was released by BizLibrary

› Archival Date (archived_date) – when the content was archived* or scheduled for archival

› Synchronization Date (sync_date) – when the content was last updated

› All dates are in Unix epoch milliseconds. 

*Content with an archive date in the past can no longer be launched.

Information  Functions

All information functions are publicly available and do not require API Keys or Billing IDs.

Field Testing

• GET /about/fields – returns the available fields for sorting, returning, searching, and faceting in search queries
• GET /about/fields/return – returns all course attributes currently available that may be returned
• GET /about/fields/search – returns all course attributes currently available that may be searched
• GET /about/fields/facet – returns all course attributes currently available that are faceted

Data Functions

All Methods

• billing_id is part of the URL as supplied by Technical Support

• The header “x-api-key” should be included on all requests
• All QueryString values should be URL encoded

Content Listing

GET - /{billing_id}/courses

Examples

Single Content Details

GET /{billing_id}/courses/{code}

• Returns a single course by course code
• All attributes for the course are returned

Poster Images

GET /{billing_id}/courses/{code}/poster

• Returns the poster image for a course by course code
• Images are returned as base64 strings (with a 16:9 ratio)

GET /{billing_id}/courses/{code}/poster/url/{width}

• Images can also be returned as a URL format allowing customization of the image width within the 16:9 aspect ratio

Launch Links

GET /{billing_id}/courses/{code}/launch_link/{standard}

• Returns formatted launch links for courses by standards supported
• Valid values: AICC, SCORM12, SCORM2004, and CMI5

Export

POST /{billing_id}/courses/export

• Raw JSON Body Post
• Content-Type application/json.api+json adheres to JSONAPI format requirements

Example AICC Export for Business Skills Content

{

"filterQuery": "(and topic0:'Business Skills')", "query": "-nomatch",

"standard": "AICC",

"recipients": "example@bizlibrary.com", "packaging_options": "all_items", "single_content_file": "true", "zip_each_course": "true"

}