Recorder API
With the Recorder API you can embed a "Record Screencast" button any where to upload to your Channel on Screencast-O-Matic.com. For example if you wanted to collect tech support bugs from users on your website.
To use the Recorder API you need the Recorder API Plan. Please contact sales@screenpal.com to purchase your plan. The 1st month is free and allows you to integrate and test the Recorder API before making payment.
Take a look at our tutorial on Setting up an Embedded Recorder which goes over how to get started by:
- Creating a Channel on your Screencast-O-Matic.com account
- Setting up the recorder to embed.
- Copy-and-paste javascript for recorder into your html.
When you embed the javascript you can add some extra settings, using customData and callback as exampled below:
Setting a customData object with key/value pairs will save the data so it's passed back in the callback function and in JSON for the WebHook if you have one defined (see more about WebHook Callback below).
Setting a callback function will allow you to receive a javascript callback after the recorder is closed. If a screencast is uploaded from the recorder then the function will be called back with a javascript object containing details for the upload OR undefined if no screencast was uploaded.
When using the javascript callback, the end user should not navigate away from the page where the recorder is launched or else the javascript callback won't be called.
The javascript object will contain the following details:
If you also check the box in your recorder settings to "Include links and embed tag in javascript callback" then you also get links and an embed tag to what was uploaded:
You can set up a WebHook callback so a POST request is made from our servers back to your system when an upload is made. You can supply either an HTTP or HTTPS URL which can also be prefixed with a username and password for basic authentication like: username:password@http://.... The POST request will contain JSON with the same data provided in the javascript callback with all the links to the upload that was created like:
If the system fails to post to your server then it will retry until it successfully posts.
Ready to get started? Contact Us for more details on the Recorder API Plan pricing and start a free 1-month trial.