Integration of the platform. Technical specifications

Transcription

1

2 Introduction This document is meant as a reference and specification guide to carry out the integration between Gamelearn s platform and the different Learning Management System platforms of the client, hereinafter LMS. It describes the technical elements employed and the details of configuration and use of each of them. Objective of the integration There are two main objectives. On the one hand, to provide a single sign-on access (hereinafter SSO) in order to prevent the user of corporate LMS from having to re-enter or remember new credentials, username and password. On the other hand, to offer LMS the possibility of using a Web Service that provides information on the progress of users to Training or HR managers. Single Sign-On: SAML and Access Token The LMS platform of the client must act as an identity provider for Gamelearn s platform inorder to prevent the user from having to remember or enter new credentials, ie the login process would be internal and transparent to the user, without having to display a page where the user would need to enter their username and password. There are two types: SAML SAML 2.0 is an open standard that defines a framework for the exchange of authentication and authorization data. Usually, the parties involved in the exchange are an identity provider, in this case the LMS or Active Directory of the client company, and a service provider, in this case Gamelearn. The LMS will request access to the platform to the service provider (Gamelearn), who in turn requests and obtains, if successful, a confirmation of identity from the identity provider, the client company (LMS or Active Directory). On the basis of the confirmation received, the service provider can make decisions about the authorized access of a user.

3 To that purpose, it will be necessary to have an Identity Provider (IdP); Gamelearn should be provided with metadata (XML) of the IdP of the client company and the X.509 certificate. When the end user of the course clicks on the link to Gamelearn s platform, client and Gamelearn servers will communicate using the SAML standard to provide access to students without having to log in again. Access Token The second option for the integration of client companies which do not have IdP is designed based on the identity of the corporate user of the client company. In the LMS of the client company, there will be a link taking the user directly to the platform without having to enter their credentials, skipping the login screen, since authentication will be checked at server level. The user identity must consist of their address and the credentials of the platform with a hash code known by Gamelearn s course and the LMS platform of the client. A GET request will be made from the LMS client to the following URL: Being a token a string like this: base64( + : + clientid + : + SHA1( + sharedkey)) The clientid and sharedkey parameters will be provided by Gamelearn when this type of SSO integration is required. The parameter will be the corporate mail address of the LMS platform user, which will have been previously registered in Gamelearn as a student. If the result is correct, the call returns an HTTP 302 redirect that will take the user directly to the platform. If an error occurs, an HTTP 400 code indicating its causes will be returned.

4 Reporting Information about groups, the students forming them and their details will be always available within the platform for HR managers or those responsible of the courses. In addition, Gamelearn offers the possibility to the LMS platform of the client to access the progress of the courses in real time, at any moment, to show that progress in the integrated environment of the LMS platform. The LMS platform of the client may call Gamelearn s API REST to require data on the progress of users. For this, they will need to provide Gamelearn with the user's identity and credentials in the platform to guarantee the origin of queries. POST request: POST parameter 1: (string) = user POST parameter 2: activitytoken(string) = client LMS course identifier POST parameter 3: token(string) = base64( sha1( sharedkey + activitytoken + ) ) Respuesta en caso de error: { result : false, error : Sessions not available for this user } Respuesta satisfactoria: { @domain.com, total_score : 10000, level : 5, session_number : 2, average_session_duration : 3:21:58, total_session_duration : 6:43:56 }

5 Test environments Gamelearn has a pre-production environment on separate servers for the testing of platform integration. The URL of the pre-production environment of the platform will be provided by the technical staff of Gamelearn, along with trial licenses, at the time of starting the integration. On to the Production Environment To change from the pre-production environment to the production environment, URLs of the production environment of each course, together with the new shared authentication keys for that environment must be requested to the technical staff of Gamelearn.