Overview
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 share sessions to meet the specific needs of your application.
Presenter Options
We offer you two options for sharing your screen:
- Installation-free - Neither the presenters nor viewers need to install any software.
- Native app - Available on Windows and Macs
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.
Authentication
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 authtoken, which
should be passed as a request header.
Requests
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.
Responses
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.
