The Screenleap API offers you and other developers an easy way to add screen sharing to your online products and services. The documentation will show you how to use the API and the various options for customizing the screen shares to meet the specific needs of your application.
The presenter app is the program that captures your screen content and sends it onward to your viewers. This is the same app that is used on the Screenleap site.
We offer you three options for sharing your screen:
- Native app - Available on Windows and Macs; Minimum of version 8 if using Internet Explorer
- Browser extension - Allows your users to share their screens by only installing a Chrome browser extension.
- Java applet Deprecated - Requires presenters to have Java installed; Cannot be used if you need to support the Chrome browser
All presenter apps provide a console (shown below) that can be used to control the screen share. Using the API, you can customize which UI elements are shown on the console. You also have the option of implementing the controls directly in your web page and controlling the presenter app by making calls to the API.
All API requests must include a valid
accountid. You choose your account ID when you sign up for a developer
account. The account ID may be included in your API requests as either a request header or a query string parameter.
In addition to the account ID, all API requests must include a valid
This authentication token is used to authenticate your API requests and may only be passed as a request header.
Screenleap offers a REST-style API that uses JSON for serialization. API calls require the use of the correct HTTP request method (GET/PUT/POST/DELETE). Calls without the correct HTTP method will return with an error.
All requests that require passing in the
authtoken must use SSL. Requests that only require your
accountid (such as requests to get the viewer page) can be non-secure.
The response to a request will include a HTTP status code. The status codes have the following meaning:
- 200 - The request was successful.
- 400s - The request was malformed. The JSON response will contain an
errorMessagethat provides more information about the error.
- 500s - There was a server error. Depending on the type of error, you can either try your request again later or contact us for assistance. You can also check our ScreenleapStat Twitter to see if there is a service outage.