Getting started

Before you can use the Scribblar API you must sign up to the Scribblar PRO service and be issued with a valid API key. If you have not yet received an API key then please request one now.

Step 1: Embed the Scribblar SWF
In order to integrate Scribblar into your existing website you must embed the necessary SWF (Flash file) into at least one of your site's pages. The necessary code is shown below and also contained in this zip file for download.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>Scribblar Room</title> <LINK href="//s3.amazonaws.com/media.muchosmedia.com/scribblar/styles/style.css" rel="stylesheet" type="text/css"> <script type="text/javascript" src="//s3.amazonaws.com/media.muchosmedia.com/scribblar/scripts/includes.js"></script> <script type="text/javascript"> var targetID = "scribblar"; var flashvars = {}; /* pass necessary variables to the SWF */ flashvars.userid = "0"; /* to allow an anonymous guest pass 0 */ flashvars.roomid = "r0b4jw"; /* the roomid for the room you'd like to access - substitute this for a valid roomid */ flashvars.preferredLocales = "en_US"; /* sets the language - if in doubt leave as en_US */ /* optional: if you pass userid=0 you may also pass a username to skip the username prompt and log the user in using that username flashvars.username = "John"; */ var params = {}; params.allowscriptaccess = "always"; var attributes = {}; attributes.id = "scribblar"; attributes.name = "scribblar"; swfobject.embedSWF("//s3.amazonaws.com/media.muchosmedia.com/scribblar/v4/main.swf", "alternate", "100%", "100%", "11.1.0", "//s3.amazonaws.com/media.muchosmedia.com/swfobject/expressInstall.swf", flashvars, params, attributes); </script> </head> <body scroll="no"> <div id="alternate"> <a href="//www.adobe.com/go/getflashplayer">This page requires the latest version of Adobe Flash. Please download it now.<br> <img src="//s3.amazonaws.com/media.muchosmedia.com/scribblar/assets/get_flash_player.gif" border="0" alt="Get Adobe Flash Player" /> </a> </div> </body> </html>

You may also run the samplewrapper.htm example directly and view source on it

Step 2: Create a room
Scribblar always needs to connect to a room. A room is described by a unique id, and any room may contain one or more users and may be visited multiple times. To connect to a room you must pass a valid roomid to the Scribblar SWF and you may optionally also pass a userid. To obtain a valid roomid you must first create a room via the API.

Once a valid roomid has been obtained your page can pass this to the Scribblar SWF.
flashvars.roomid = "r0b4jw";
(Note: the roomid above is just an example and must be substituted for one that you have created via the API using your API key)

The steps described above are generally automated by your backend suing your application server of choice (for example PHP, ASP, Ruby etc).Your backend logic would programmatically create a room, obtain the roomid, embed the SWF and pass the roomid to it.