Advanced Integration
Please see below for information on how to configure your API quick integration for more advanced scenarios.
Room ID
The roomId parameter needs to be added to the data-param attribute of your integration code snippet
when:
- You need a way to automatically connect presenters and viewers who are at different integration URLs with each other.
- You need to support automatically connecting multiple presenters with different sets of viewers who are all at the same integration URL. A website URL is considered identical if the hostname and path are the same.
Please note that the roomId can be any arbitrary string and is not persisted anywhere in the Screenleap
site. It is simply used as a way of connecting a specific presenter with a set of viewers. This means you can use
any value you want as long as they are unique for each group of users that you want to automatically connect. All
presenters and viewers who have the same roomId will be automatically connected when a share session
with that roomId is started.
Connecting Presenters And Viewers At Different Integration URLs
If you need to automatically connect presenters and viewers who are at different integration URLs with each other,
you can do so by providing the same roomId in the data-param attribute of the integration
code snippet for the presenters and viewers that you would like to connect.
Allowing Multiple Presenters And Viewers At The Same Integration URL to Automatically Connect With Each Other
If you need to be support automatically connecting multiple presenters and viewers who are all at the same integration URL,
you can do so by providing a unique roomId in the data-param attribute of the integration
code snippet for each presenter and the set of viewers that need to connect with that specific presenter.
For example, if you have presenter 1 and presenter 2, and you want viewer 1 and viewer 2 to automatically join
presenter 1's share session and viewer 3 and viewer 4 to automatically join presenter 2's share session, then you
will need to pass one roomId in the integration page for presenter 1, viewer 1, and viewer 2 (i.e., presenter1) and a different roomId
in the integration page for presenter 2, viewer 3, and viewer 4 (i.e., presenter2).
Auto-Login
If your integration will be from a page that requires your users authenticate themselves first, then it is possible to auto-login your users to your integration so that your users will be able to start share sessions without needing to log in to the integration manually.
To get started, you will need to create user accounts for each user that will need to access your integration. Each user
account will have an auto-login token associated with the account. The email address used to create the account, along
with the auto-login token for the account, can be passed to your integration via the data-param property
to auto-login your user into your integration.
See auto-login tokens for users in your company »
Using the auto-login pages on unauthenticated pages in your website is not recommended as the auto-login tokens are exposed, which could pose a security risk and open the user account to misuse.
