Virtual Classroom API - Frequently Asked Questions

Published:

4 mins read

Frequently Asked Questions

1) Can I use the Virtual Classroom API to integrate courses and testing platforms into my website?

Virtual Classroom API is best suitable for people who already have an existing website, LMS, CMS, or app. API integration within your website is available only for Virtual Classroom and NOT for courses, and tests.

2) Do you offer a FREE trial?

The free plan supports 2 connections (1 instructor + 1 attendee) with a maximum duration of 30 minutes per session. It supports 600 minutes of Free API usage. Upgrade your API account to use more attendees in a live session, and session duration. All paid API plans come with premium features such as more attendees in a live class, session recording feature with HD video encoding, etc.,

Generate API key here - https://app.braincert.com/app/virtualclassroom

3) Why do I get an 'Invalid API Key' error?

Please make sure you are using the right API key from https://app.braincert.com/app/virtualclassroom. A few things to check:

The launch URL should not contain spaces. For example, if you have a space after the API key, the browser adds %20 to the URL which will invalidate your API key.

The API parameters are separated by &, so make sure you not changing that separator.

|| EXAMPLE - roomId=682&apiKey=7UrWbMlO5sAx1fmVlPHK&userId=352

4) Why do I get the 'Access Denied' error?

When you launch a live class that is expired, you will get an 'Access Denied' error message. This is because the class has ended, and you cannot launch classes from the past.

5) Where is the Content Library?

Virtual Classroom API shares the same content library as the E-Learning Platform. Upload all your document files such as PDF, DOC, PPT, and media files such as MP3 and MP4. These contents will be available to use from your content library within the Virtual Classroom session.

We do support unlimited cloud disk space to host all your files.

6) Do I need to use CloudFlare to use Virtual Classroom API?

By default, all the classes launched from your website will have the API endpoint https://api.braincert.com in the URL. For branding purposes, you can map this API endpoint with your own domain such as (https://live.my-awesome-company.com). We do require SSL certificate mapping using CloudFlare to make your external domain work. Without SSL (https:// in the URL), a virtual classroom will not work.

7) Is there a direct link for the Screen Sharing plugin in Chrome?

If you have trouble installing the Chrome browser plugin for screen sharing from within the virtual classroom, open this link directly and add (install) the extension in the Chrome browser.

8) How do I download or play the recorded class videos?

With API calls, you can record and download live classes directly from your website as a 720p HD MP4 file. You can use a video player like JW player, video.js, or other players to play the video directly on your website or download and share it with your attendees.

9) How do I integrate Virtual Classroom into my website? Do you offer example plugins for CMSs like Joomla or WordPress?

Use Developer API documentation to integrate WebRTC-based HTML5 Virtual Classroom in your website which offers live audio/video conference, multiple interactive whiteboards, HTML5-based server-side session recording, multiple-language support, screen sharing, and so on. You would need to integrate it into your website by following the documentation and sample code provided in the API documentation. We do offer sample plugins for Joomla and WordPress-based websites which can be downloaded from here.

You can simply pass userID, username etc., as a parameter in the API call, and all your website user accounts can be maintained at your own website, and there is no need to create those user accounts at BrainCert.

You need to talk to a developer who understands RESTful API calls and is familiar with these types of integrations.

10) How can I cut down development time? Do you offer other solutions?

You may also want to look at Unified Training Platform - a hosted SaaS white-label solution, which comes integrated with 4 core platforms in one unified solution - courses platform, online testing platform, award-winning virtual classroom, and content management system.

Use our Enterprise LMS to cut down the integration time and easily onboard users using Single-Sign-On.

Enterprise LMS is role-based, so you can create groups like "Employees", "Customers" etc., set up courses, tests, and live classes, and collaborate securely with granular permissions and access levels.

Your LMS will look something like this https://learnems.braincert.com/ and it also allows mapping your external domain such as (http://www.emslearningpath.com/) using a simple CNAME entry in your DNS server. Enterprise LMS blends with your corporate domain and theme, and you can also configure it to Single Sign-On (SSO) from your website to Enterprise LMS with a click of a button.

Activate your domain here. It comes with a free 15-day trial.

11) Does it work on iOS and Android devices?

Mobile browsers such as Opera and Chrome on Android are fully supported. iOS devices are also supported. See the browser compatibility guide here.

12) What are the minimum requirements to use the HTML5 Virtual Classroom?

Follow this KB note to check the minimum requirements - https://www.braincert.com/braincert-support/kb/art.

13) How do I allow my website users to test their browsers?

You can have your website users use our browser check tool - https://www.braincert.com/live/html5check.php to check their browser automatically. You can also create an iFrame embed in your website using this link to hide the URL.

You may also want to use this free WebRTC troubleshooter tool - https://test.webrtc.org/.

Was this article useful?

Dislike