This document provides all the basic information you need to start using the CrossKnowledge API. It covers CrossKnowledge API concepts, shows examples for various use cases, and gives links to more information.
Overview
The CrossKnowledge API offers to our clients, partners or independant software vendors, a powerful way to create innovative learning application or to integrate with HRIS platform or any third party application.
The CrossKnowledge API includes :
Authentication & Authorization workflow
Access to the CrossKnowledge Learner API using the CKAuth authentication workflow.
Learn MoreLearner API
Get data on behalf of the authorized user using CKAuth authentication workflow.
Learn MoreData Exchange Interfaces
Integrate systems using flat files data exchange.
Authentication & Authorization workflow
The CrossKnowledge Authentication Service grants access to client application so they can access private data on behalf of the authenticated learner.
Learner API
The web-services included in our Learner API enable third party application to get the data from the CrossKnowledge Learning Suite on behalf the authenticated user. The returned data are contextualized to the learner logged during the web-service call out.
Below is and exhaustive list of the web-services ordered by data object:
Description:
This web-service enables a third party application to get (read) the current authenticated learner profile information.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the current authenticated learner's manager profile information.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the current authenticated learner subordonates profile information.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the training in which the current authenticated learner is enrolled.Click here to see how it works.
Description:
This web-service enables a third party application to search a training available for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the training Sessions in which the current authenticated learner is enrolled.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the Sessions folder hierarchy for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the learning objects available for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the data of a specific learning object available for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the data of themes for learning objects available for the current authenticated learner .Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the learning objects's type available for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to download a specific learning object on the device of the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to allow an authenticated learner to vote for a learning object.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the tracking data (report) on learning object available for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to set/ update the tracking data (report) on learning object available for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to get/set/update the trackings data (report) for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) available discussions of the current authenticated learner and their comments. The discussions are returned from the newest to the oldest, accordingly to their visibility and the optionnal filter on context. Comments for a given discussion are returned from the newest to the oldest as well..Click here to see how it works.
Description:
This web-service enables a third party application to set a discussion for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application to set a new comment to a specific discussion for the current authenticated learner.Click here to see how it works.
Description:
This web-service enables a third party application the current authenticated learner to like or dislike a comment.Click here to see how it works.
Description:
This web-service enables a third party application to subscribe the current authenticated for the following of a given discussion.Click here to see how it works.
Administration API
The web-services that are part of the CrossKnowledge Administration API give the possibility to get and set data into CrossKnowledge platform data in order to improve business workflow by :
- Building custom business logic outside the CrossKnowledge platform,
- Creating specific learning data analytics dashboard,
- and more.
Description:
This web-service enables a third party application to get the data of a specific learner account existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to list the data of learners accounts existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to add (insert) a new learner account in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to edit (update) the data of a specific learner account existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the data registrations of a specific learner account.Click here to see how it works.
Description:
This web-service enables a third party application to get an authorization token for a specific learner account.Click here to see how it works.
Description:
This web-service enables a third party application to get the data of an existing entity in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to list the data of all existing entities in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to list all the trainings existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the metadata of an existing training in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to add( insert) a new training in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to edit (update) the meatadata of an existing training in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application list to all the sessions existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to get (read) the metadata of an existing session in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to add( update) a new session in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to edit (update) the metadata of an existing session in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service allow to register/ enroll a learner to an existing session in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to get a registration existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to delete a specific registration existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to get the metadata of learning object in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to list the metadatas of all the learning objects existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to get a secured authentication URL (SSO) for a specific administrator account existing in the CrossKnowledge platform.Click here to see how it works.
Description:
This web-service enables a third party application to edit (update) an existing administrator account in the CrossKnowledge platform.Click here to see how it works.