Introduction
Screenleap offers programmatic access to our real-time collaboration platform for developers looking to incorporate screen sharing, audio conferencing, and video conferencing into their web sites and apps.
Features
Quick Integration
A basic integration consists of making a single HTTP request to create a new share session. The returned JSON
includes:
- A JSON object which you can use to launch the share session
- A URL through which the share session can be viewed
Customizable Interface for White-Labelling
Customization options enable you to integrate live interaction seamlessly into your web site and apps and customize both the presenter and viewer UI with your own branding.
Pricing
We give you five hours of free sharing to get you started. This gives you a risk-free way of trying out the API to see if it meets your needs.
Additional API sharing time is billed based on usage. It is priced as follows:
| Tier | Basic | White-Label |
|---|---|---|
| Cost per participant | $0.003/minute | $0.010/minute |
| Benefit | Economical | Branded Experience |
Please visit our API pricing page for more information about our pricing.
Requirements
Application Requirements
The Screenleap API is designed for integration with web-based applications. Your application needs the ability to make HTTP requests to our servers and process the returned JSON data. You must also be able to modify the web page that you want to integrate with.
Presenter Requirement
Screenleap provides multiple presenter app types in order to meet your specific sharing needs:
| Pros | Cons | |
|---|---|---|
| Installation-free |
No download Works on all modern browsers Easy integration Additional features supported with native add-on: rectangle mode, remote control |
|
| Native app | No additional add-on required for native features: rectangle mode, remote control |
Software download required; Mac and Windows only; Mac app requires Mac OS X 10.12 and higher; Windows app supports Windows 7 and later |
| Browser extension (deprecated) |
No download Does not require installation of third-party software (i.e. Java) |
Share browser content only (except Chrome) Only available for Chrome browser |
Viewer Requirement
To view a shared screen, a user can use any modern web browser. We require version 11 and above of Internet Explorer. No additional software is required.
Documentation
Please see the API documentation for information on how to use the API, integrate the presenter app to enable sharing, and integrate the viewer to enable viewing. The examples are shown using the cURL command-line tool.
