Skilljar has API updates that you might be able to leverage to improve your integration of adding courses and content into Skilljar.
Note: This article is focused on Developers and Integrations that are looking to build out API tooling that automatically adds content to Skilljar
Create or Update a Course and Lessons
Recommendation on how you might want to setup this flow:
- Store a Skilljar API key to the integration config which can be created in the Skilljar Dashboard.
- Create the Content Via Content APIs
- Create Skilljar Assets
- WebPackage
- Asset (used for Videos, PDFs, Iframe embeds)
- Create Skilljar Assets
- Create Skilljar Courses
- Creates Skilljar Lessons
- Associates relevant Assets to the lessons or lesson content items
Once this content Is created in Skilljar, an Admin can go review the content, settings, and Publish this content to the relevant training domains.
Full API Details for these instructions
- Create Assets/Web-packages that will be used in the lessons in the course
- https://api.skilljar.com/docs/#assets-create
- https://api.skilljar.com/docs/#web-packages-create
- Store the relevant Asset/Web-package IDs for Lesson Creation API calls
- Create the Course Object
- https://api.skilljar.com/docs/#courses-create
- Store the relevant course ID for Lesson Creation API calls
- Create Lessons in the course
-
https://api.skilljar.com/docs/#lessons-create
- For SCORM providers: Use the WebPackage ID in the relevant field (and make the lesson type=WEBPACKAGE) to create SCORM lessons in the course
- For VIDEO providers, You can either use Type=VIDEO and link the Asset ID or can create a MODULAR lesson which allows adding a Video and HTML to the same lesson object
- If this is a MODULAR lesson (multiple assets in one lesson object) then each lesson content Item can be added in via the Lesson Content Item Endpoints with lesson ID as the required input
- Use the relevant IDs from Asset creation above to assign Assets to the relevant lessons upon creation
-
https://api.skilljar.com/docs/#lessons-create
Note: Deletion of Courses/Lessons/Assets must happen within the Dashboard
Note: The "Try it out" feature on api.skilljar.com/docs is very useful to test out your API flows, but some URLs provided in the JSON response may not format correctly in the main widget (eg. Asset download URLs). These are formatted correctly in the "RAW" response if you are looking to accurately represent what your systems will be able to access when using the Skilljar API.
Note on Webpackage Replacement:
Updating an existing webpackage across many lessons can now be achieved using the https://api.skilljar.com/docs/#web-packages-lessons endpoint.
This endpoint mirrors the “Replace” functionality that can be found on the SCORM Asset page.
Create Live Training Events
Recommendation on how you might want to setup this flow:
- Store a Skilljar API key to the integration config which can be created in the Skilljar Dashboard.
- Look up the course and Lesson to have the relevant IDs when creating events
- Look up the Instructor Options if creating an Event with an Integration
- List instructors - can be filtered by email or integration type
- Create the ILT events
- uses stored API key to call relevant APIs to create ILT sessions or MSE objects
- For MSEs, the MSE should be created prior to the individual sessions
- For Sessions, only the ILT lesson is needed
Full API Details for these instructions
- Get the Lesson ID for the course that these events are being added to
- Getting the Lesson ID may require having the course id
- Lesson ID
- Store the lesson ID for later Session Creation
- List ILT instructors (if using an integration type)
- https://api.skilljar.com/docs/#lessons-list
- Filter by email or Event type
- Store the Instructor email/type
- (Optional if using MSE) Create MSE object
- https://api.skilljar.com/docs/#ilt-multi-session-events-create
- Store the MSE ID if needed
- Create Session
- https://api.skilljar.com/docs/#ilt-sessions-create
- Lesson ID is required for Single events, MSE ID is required if hte event is part of a Multi Session event