What is This Electa Live API Designed For
The purpose of this API is to link an existing web based system (LMS, SMS and CMS) with an Electa Live hosted account. This API requires an active Electa Live subscription which supports API calls.
With the API you can access your virtual classrooms directly from your website placing students and session moderators with one single authentication procedure - on your website.
Enabling and Disabling the API Access
The API access is enabled through the web based control panel. You must be logged in with an administrator account. To access the API settings visit Account Settings -> HTML Integration and API menu. Then click on “API Access Settings” link.
On the following page you will find your numeric Account Id (or Customer Id) and Application Key. They are needed to access the API.
The API is enabled when there is an Application key specified. Click on the Generate New Key button to generate an API key.
To disable the API access you have to clear the Application Key and save or just click the Disable API Access button.
Finally click Apply to save all changes.
Important: You Application Key must be kept in secret. Please do not expose/transfer your application key to the client browser when accessing the API. Always use server-to-server communications when you have to call a function that requires an Application Key. If your key gets compromised generate a new one as explained above.
The API is divided into several namespaces designed to handle different operations.
Authentication Namespace – this is the most important namespace which authenticates all calls to the API through session tokens. This is the first call that has to be done before attempting any other calls to other namespaces.
Direct Classroom Access Namespace – this namespace is designed to launch a classroom directly from the client browser placing the attendee into the classroom.
Recorded Sessions Namespace- this namespace exposes functionality to extract recordings from the recorded session’s library.
Reporting Namespace – this namespace implements calls that extract attendance log records for reporting purposes.
Optionally provide private feedback to help us improve this article...
Thank you for your feedback!