Quick Start Guide

Screenleap

Integrating with Screenleap's live-interaction platform with your website is easy: all you need to do is

1) specify the URL of your website in the API quick integration page,
2) customize what features you want to use from the API quick integration settings page, and
3) add a snippet of code to your website.

An example code snippet:

Please note that the code snippets for presenters and viewers are slightly different. You need to make sure that you include the correct code snippet depending on whether your users will be joining as a presenter or a viewer. Please see the integration page for the specific code snippets to use.

Configuration

Once you have added the integration code snippets to your website, you can configure your integration to suit your needs from the API quick integration settings.

Please see the API configuration page for more information about specific configuration settings.

Connecting Your Presenters and Viewers Automatically

The Screenleap API quick integration feature supports automatically connecting your presenters and viewers to an active live-interaction session.

Connecting Presenters and Viewers at Same URL Automatically

The easiest way to automatically connect your presenters and viewers on your website is to use the same website URL for your presenter and viewer integration page. This means that both your presenters and viewers will go to the same URL on your website to start and join a live-interaction session. A website URL is considered identical if the hostname and path are the same, but the query parameters can be different.

Since the integration code snippet is different for the presenter and viewer integration, you will need some way of determining whether to include the presenter or viewer code snippet in your integration page for a user depending on whether they will be joining as the presenter or as a viewer. The easiest way to accomplish this is to use a query parameter to differentiate between whether to render the presenter or viewer integration page.

For example, if the website URL that you want to integrate with is https://www.mysite.com/share, you can pass https://www.mysite.com/share?screenleap-role=presenter for the presenter integration page and https://www.mysite.com/share for the viewer integration page.

Connecting Presenter and Viewers at Different URLs Automatically

If you want to use different URLs for the presenter and viewer integration page, you will need to pass in a roomId parameter in the data-param attribute of your integration code snippet. The roomId parameter is required for us to be able to connect users at different integration URLs together. The roomId should be unique for each set of users that on your website that you want to be able to connect together in a live-interaction session.

The next page provides more information on how to automatically connect users at different integration URLs.

Continue to Advanced Integration »