Add Live Interaction To Your Website
You can now easily add support for live interaction (screen sharing, video conferencing, audio conferencing, chat, and more) to your website using our new integration feature. Our integration feature allows you to start live-interaction sessions directly from your website. Other users on your website will be able to join your live-interaction sessions from any device with a web browser without needing to install any additional software. Best of all, your users will not need to manually click on any share links or enter any share codes to join your live-interaction sessions: they will be automatically connected when your sessions start.
You can use our live-interaction integration feature to turbocharge your sales process, provide your users with more helpful support, collaborate more easily with external users, and more. Please take a look at the integration use cases page for ideas on how our integration feature can improve your online interactions with your users.
Requirements
The requirements for integrating our live-interaction platform with your website are:
- You must be able to modify your website to add a small snippet of code (see the Integration section below for a sample snippet).
- Your website must be secure (the URL of the page you are integrating with must use
https://). - Your users must be using a modern browser (Chrome, Edge, Firefox, and Safari). Viewing from mobile and tablet devices is supported, but sharing is not currently supported.
Integration
Integrating Screenleap's live-interaction platform with your website is easy. You can get a basic integration up and running in under 10 minutes. All you need to do is
- specify the URL of your website in the integration setup page,
- customize what features you want to use from the integration settings page, and
- add a snippet of code to your website.
An example code snippet (do not use as your code snippet will be slightly different):
Please note that the code snippets for presenters and viewers may be slightly different. You need to make sure that you include the correct code snippet depending on your configuration. Please see the integration setup 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 your user integration settings.
Please note that if you are using the company integration, some integrations settings will be specified at the company level while other integration settings will be customizable on a per-user basis for each user in your company. User-specific integration settings will be applied after a user signs in to from the presenter integration page on your website.
Please see the integration 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.
Please take a look at our advanced integration page for more info.
Free Accounts
To make it easier for you to try out the integration feature, we have made the integration feature available on all account types—including free accounts. Integrations for free accounts are limited to the functionality available on the free accounts and subject to the daily time limit for free accounts (currently 40 minutes per day).
Free account integrations will show Screenleap's branding to your users. Your users will also be redirected a promo page at the end of the share session. Upgrading to a paid account will remove the redirection to the promo page at the end of the share session. If you would like to white-label the integration feature to show your own company's name, logo, and branding, you can do so by upgrading to a Premium or Max account.
