Wetpaint Injected - Recently Updated Pages

Wetpaint Injected Resources

wetpaint — Fri, 04 Nov 2011 10:49:39 CDT

IMPORTANT NOTICE: Wetpaint Injected End of Life

The Wetpaint injected platform has reached end-of-life as of 11/01/2011. The platform has been switched to read-only mode and all API calls will be disabled by 11/11/11.

Welcome to Wetpaint Injected! With just a few lines of code and a bit of configuration, you can empower your users to create their own content on the pages of your choosing. Wetpaint makes this all possible thanks to embedded user-generated content, a lightweight integration, and a seamless user experience. How to Use This Site Browse the Table of Contents or use the "Search this site" box in the upper left corner to find a topic. Can't find the answer? Post your question in the Discussion Forum.

Welcome to Wetpaint Injected!

With just a few lines of code and a bit of configuration, you can empower your users to create their own content on the pages of your choosing. Wetpaint makes this all possible thanks to embedded user-generated content, a lightweight integration, and a seamless user experience.

How to Use This Site

Browse the Table of Contents or use the "Search this site" box in the upper left corner to find a topic. Can't find the answer? Post your question in the Discussion Forum.

Have questions about a site_name.wetpaint.com site? Visit Wetpaint Central

Visit our Community Contributed Application Showcase to download cool Wetpaint Injected powered widgets, plugins, mashups, etc.

Important notices!

Environment and API changes. Please review

Getting Started

Read Up

Get great results by reading up on Wetpaint Injected Best Practices.

For Developers

Start Developing

Start using Injected today! Start with our step-by-step integration guide.

Get Support

Find out what others in the community are doing with Injected. Learn more by reading our discussion forums.

Tip! Quick-start your integration! Check out the Tutorials, Sample Code, and Applications

What is Wetpaint Injected?

Quick Start Guide

wetpaint — Tue, 15 Dec 2009 15:04:18 CST

Wetpaint Injected consists of two components: the JavaScript client application and a set of data access APIs. Injecting user-generated content into one of your pages is a very simple process. By following these two easy steps, you can be up and running in minutes.

Don't have your developer key yet? Get it now!

Step 1. Add User-Generated Content To Your Page

Adding user-generated content to your page is easy: you inject it with a server-side include (SSI). See our Sample Applications for examples of how to do this on the more common Web platforms. Use the following URL for testing, then see other options for retrieving content:

http://wapi.wetpaint.com/CellService/getCellContent.do?key=507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef&ns=sandbox-trial&cell.cellId=sample&cell.displayName=sample&cell.url=http://www.wetpaint.com

Step 2. Add the JavaScript Client Application

The Wetpaint Injected client application offers rich WYSIWYG editing and client-side controls for injected content. It must be loaded somewhere above the first injected content cell -- typically in the <head> of the HTML page. Just include the following snippet:

if( window.WPCAPI ) {
WPCAPI.setDeveloperKey("507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef");
WPCAPI.setNamespace("sandbox-trial");
WPCAPI.setLoginTicket("<your login ticket>"); // only required if user is logged in
WPCAPI.processLogin = function() { location.href = "/path/to/login/page"; }
}

</script>

Note: Wetpaint Injected displays a login dialog if a user attempts to perform a privileged action (e.g: edit a content cell), but does not have a login ticket. When the user clicks the Login button in this dialog, WPCAPI.processLogin() is executed. You should override this function to perform the action(s) necessary to login the user (and ultimately provide them with a ticket). Example behavior is shown in the snippet above. For more information about retrieving a login ticket and authenticating a user, see the full Integration Guide.

Now you have SEO-ready user-generated content on your site and a clickable EasyEdit button. Woohoo!

What's Next?

Your first set of API calls were made in our Quick Start Sandbox. Check out our API Reference to see what other calls you can make. Ready for your own developer key? Sign up for one today. Once you receive your own private developer credentials, be sure to cover all the bases and visit our full Integration Guide.

Next: Integration Guide

Hello World Tutorial

steve — Tue, 15 Dec 2009 14:50:51 CST

This "Hello World" Tutorial describes the basic steps required to integrate Wetpaint Injected content into a website. (est. 10 minutes)

Note:

For a non-technical overview, visit the How it Works page on wetpaint.com

Specifically, this tutorial will walk you through the following steps:

Retrieve "Hello World" content from the Wetpaint Injected API

Display the "Hello World" content on your web page
Add the Wetpaint Injected client library to your web page

Enable the EasyEdit button

Enable your users to edit and save the "Hello World" content

Step 1: Retrieve "Hello World" Content from the Wetpaint Injected API

Your server side pages can retrieve the "Hello World" content from the Wetpaint Injected API using a RESTful URL of the following format:

http://wapi.wetpaint.com/CellService/getCellContent.do?key=developerkey&ns=namespace&cell.cellId=cellname

This URL retrieves the "Hello World" content from the Wetpaint Injected API, providing it the following values:

Developer Key - a unique key provided when you are approved for Wetpaint Injected (e.g. "507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef")
Namespace - this is a unique name for your application, provided by Wetpaint when you are approved (e.g. "sandbox-trial")
Cell Name - this is the cell that contains the content that your users may edit. (e.g., "sample")
Cell.displayName - this is the name of the person who logged in to edit the wiki. (e.g., "testuser")
cell.url - this is the url to reference to the original page.

These values are working examples that you may use for test purposes. Get your own developer key today. The following is an example of the URL with working test values:

You can try this example by clicking on the RESTful URL and viewing the results in your web browser. View the page source to see the raw "Hello World" content that is returned from the Wetpaint Injected API. The content is contained within "<div>" tags to enable easy integration and formatting into your web page.

Step 2: Integrate Raw Content into Your Webpage

Place the content you retrieved from the Wetpaint Injected servers into your webpage where you want it to appear. For example you may output the content below the "<body>" tag as follows:

PHP:

<html>

ASP.NET: Custom Server Control by Atilla Yadik at Webhun.com. You will find 2005 and 2008 version of the control. Enjoy.

<%@ Page Language="C#" %>
<script runat="server"> protected void Page_Load(object sender, EventArgs e)
public String renderWetpaintContent() {
Uri wpUrl = new Uri("http://wapi.wetpaint.com/CellService/getCellContent.do?key=507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef&ns=sandbox-trial&cell.cellId=sample&cell.displayName=testuser&cell.url=www.example.com&output=html");
System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.CreateDefault(wpUrl);
request.Method = "GET";
System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();
System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
return reader.ReadToEnd().ToString();
}
</script>
<html>
<body>
<%=renderWetpaintContent() %>
</body>
</html>

JSP:

<%@ page import="java.util.*" %>
<%@ page import="java.io.*" %>
<html>
<body>
<%

String developerKey = "507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef";
String namespace = "sandbox-trial";
String cellName = "sample";
String cellDisplayName = "Testuser";
String cellUrl = "http://www.example.com";
StringBuffer urlString = new StringBuffer("http://wapi.wetpaint.com/CellService/getCellContent.do?");
urlString.append("key="+developerKey);
urlString.append("&ns="+namespace);
urlString.append("&cell.cellId="+cellName);
urlString.append("&cell.displayName="+cellDisplayName);
urlString.append("&cell.url="+cellUrl);
URL url = new URL(urlString.toString());

HttpURLConnection connection = (HttpURLConnection)url.openConnection();
connection.setRequestMethod("GET");
connection.setDoInput(true);
connection.setDoOutput(false);
connection.setUseCaches(false);

InputStream istrm = connection.getInputStream();
ByteArrayOutputStream bstrm = new ByteArrayOutputStream();
int ch;

while ((ch = istrm.read()) != -1) {
bstrm.write(ch);
}

String s = new String(bstrm.toByteArray());
bstrm.close();
out.println(s.toString());
%>
</body>
</html>

The examples above return raw "Hello World" HTML from the Wetpaint Injected API and renders it into a web page, providing SEO benefits (see "before" image below).

Step 3: Add the Wetpaint Injected Client Library

The Wetpaint Injected client includes libraries of code that provide tools to enable your users edit the content. It also includes a stylesheet that provides formatting. To add the client to your webpage, include the following script tag in the Head section of your HTML:

<html>
<head>
<script src="http://wapi.wetpaint.com/JavaScriptService/getBootstrap.do?key=<your developer key>" type="text/javascript"></script>
</head>
<body>
...

After adding the script code, your webpage now includes Wetpaint Injected client controls instead of text (e.g. the EasyEdit button and the "What's this?" link):

Web page Before and After Client is Added

Step 4: Enable the EasyEdit Button

To enable visitors to view the "Hello World" content, you need not do anything. But to enable visitors to edit the content, you need to enable the Wetpaint Injected EasyEdit button and require your visitors to login.

If your visitor is not logged in, you need to enable the EasyEdit button and direct the user to login. To enable the EasyEdit button, you will need to add the following script section to the Head section of your HTML:

<html>
<head>
<script src="http://wapi.wetpaint.com/JavaScriptService/getBootstrap.do?key=<your developer key>" type="text/javascript"></script>
<script type="text/javascript">

if( window.WPCAPI ) {
WPCAPI.setDeveloperKey("507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef");
WPCAPI.setNamespace("sandbox-trial");
WPCAPI.processLogin = function() { location.href = "/path/to/login/page.htm"; }
}

</script>
</head>
<body>
...

This authentication script sets the following Wetpaint Client (WPCAPI) properties:

Developer Key - same as before (e.g. "507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef")
Namespace - same as before (e.g. "sandbox-trial")
ProcessLogin - this is the URL to your login page (e.g. "/path/to/login/page.htm")

Note:

This is the same developer key and namespace that were used in Step 1.

The Please Login Dialog Box

Now, when the user clicks the EasyEdit button, the Please Login dialog box appears.

Step 5: Enable your users to Login and Edit the "Hello World" content

After clicking the Login button, your user will be directed to the login page you specified in the processLogin property. You handle the user login as you normally do on your site, except, once the user successfully logs in, your server needs to use the Wetpaint Injected UserService API to obtain a Login Ticket on behalf of the user. This Login Ticket is used by the Wetpaint Client to enable the user to save their edits.

You may obtain a Login Ticket from the Wetpaing Injected UserServer API using the following:

PHP:

<html>

<body>

<?php

$userId = 'UserId';

$displayName = 'TestUser';

$email = "test@email.com";

$key = '507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef';

$secret = "yoursecretkey";

$ns = 'yournamespace';

$ts = time();

$sig_data = $key . $displayName . $ts;

$sig = hash_hmac( "sha1", $sig_data, $secret, FALSE );

$url = "http://wapi.wetpaint.com/UserService/login.do";

$post_fields.= "key=$key";

$post_fields.= "&ns=$ns";

$post_fields.= "&output=api";

$post_fields.= "&cred.ts=$ts";

$post_fields.= "&cred.sig=$sig";

$post_fields.= "&user.userId=$userId";

$post_fields.= "&user.displayName=$displayName";

$post_fields.= "&user.email=" .htmlentities($email);

$post_fields.= "&user.emailOptIn=true";

$post_fields.= "&user.profileUrl=";

$post_fields.= "&user.role=moderator";

$chandle = curl_init(); // Initialize a handle

curl_setopt($chandle, CURLOPT_URL, $url); //Set Url

curl_setopt($chandle, CURLOPT_POST, 1); //Send as POST

curl_setopt($chandle, CURLOPT_POSTFIELDS, $post_fields); //POST Fields with Values

curl_setopt($chandle, CURLOPT_RETURNTRANSFER, 1); //return results as String

$result = curl_exec($chandle); // execute the call

curl_close($chandle);

if( preg_match( "/<ticket>(.*)<\/ticket>/", $result, $match_array ) == 1 ) { //Get ticket value

$wetpaint_ticket = $match_array[1];

$ticket = $match_array[1];

//setcookie("wetpaint-togo",$ticket, time()+3600*12 ); // Probably you will save value in cookie

}

?>

</body>

</html>

Asp.Net:

using System;
using System.Collections.Generic;
using System.Linq; using System.Web;

public static class LoginManager
{

public LoginManger()
{

// // TODO: Add constructor logic here // }

public static String EnsureLoginWP(string userID, string userName, string userDisplayName, string userUrl, bool userEmailOptIn, string userEmail, string cellId)
{

//requirentments
string url = "http://wapi.wetpaint.com/UserService/login.do";
Uri uri = new Uri(url);
string developerKey = "507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef";
string developerSecret = "yoursecretkey";
string ns = "yournamespace";

//session
System.Web.HttpContext context = System.Web.HttpContext.Current;

//ticket variable holds the return ticket value
string ticket;

TimeSpan ts = (DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0));
long unixTime = (long)ts.TotalSeconds;
System.Text.UTF8Encoding encoding = new System.Text.UTF8Encoding();
String sigString = developerKey + userID + unixTime;
System.Security.Cryptography.HMACSHA1 hmacSha = new System.Security.Cryptography.HMACSHA1(encoding.GetBytes(wetPaint.DeveloperSecret));
byte[] sigHash = hmacSha.ComputeHash(encoding.GetBytes(sigString));
//byte[] sigHash = sha.ComputeHash(encoding.GetBytes(sigString));

string encodedSigString = GetAsHexaDecimal(sigHash);

string data = "key=" + developerKey + "&ns=" + ns + "&output=api&user.userId=" +
userID + "&user.email=" + userEmail + "&user.emailOptIn=" +
userEmailOptIn + "&cred.ts=" + unixTime + "&cred.sig=" + encodedSigString +
"&user.profileUrl=" + userUrl + "&user.displayName=" + userDisplayName;
string encodedData = System.Web.HttpUtility.UrlEncode(data);
System.Net.HttpWebRequest request = (System.Net.HttpWebRequest)System.Net.WebRequest.CreateDefault(uri);
request.ContentType = "application/x-www-form-urlencoded";
request.Method = "POST";
request.ContentLength = data.Length;

System.IO.StreamWriter writer = new System.IO.StreamWriter(request.GetRequestStream());
writer.Write(data);
writer.Close();

System.Net.HttpWebResponse response = (System.Net.HttpWebResponse)request.GetResponse();
System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
string responseString = reader.ReadToEnd();

if (!responseString.Contains("<ticket>"))
{

//throw an exception }
else
{

String[] tokens = { "<ticket>", "</ticket>" };
String[] splits = responseString.Split(tokens, StringSplitOptions.RemoveEmptyEntries);
ticket = splits[1];
context.Session["WetpaintTicket"] = ticket; }

return ticket; }

public static string GetAsHexaDecimal(byte[] bytes)
{
System.Text.
StringBuilder s = new System.Text.StringBuilder();

int length = bytes.Length;

for (int n = 0; n < length; n++)
{
s.Append(
String.Format("{0,2:x}", bytes[n]).Replace(" ", "0")); }

return s.ToString(); } }

JSP

<%@ page import="java.net.*" %>
<%@ page import="java.util.*" %>
<%@ page import="java.io.*" %>
<html>
<body>
<%
if (request != null) {
String username = request.getParameter("username");
URL url = new URL("http://wapi.wetpaint.com/UserService/login.do");
String developerKey = "507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef";
long ts = Calendar.getInstance().getTime().getTime() / 1000L;

HttpURLConnection connection = (HttpURLConnection)url.openConnection();
connection.setRequestMethod("POST");
connection.setDoInput(true);
connection.setDoOutput(true);
connection.setUseCaches(false);

String sigString = developerKey + username + ts;
SecretKeySpec signingKey = new SecretKeySpec( "secret".getBytes( "UTF-8" ), "HmacSHA1" );
String sigHashString = null;
try {
Mac mac = Mac.getInstance( "HmacSHA1" );
mac.init( signingKey );
byte[] hash = mac.doFinal( sigString.getBytes( "UTF-8" ) );
sigHashString = new String( Hex.encodeHex( hash ) );
} catch ( NoSuchAlgorithmException e ) {
out.println(e.getMessage());
} catch ( InvalidKeyException e ) {
out.println(e.getMessage());
}

StringBuffer requestData = new StringBuffer();
requestData.append("key=");
requestData.append(developerKey);
requestData.append("&ns=");
requestData.append("sandbox-trial");
requestData.append("&cred.ts=");
requestData.append(Long.toString(ts));
requestData.append("&cred.sig=");
requestData.append(sigHashString);
requestData.append("&user.email=");
requestData.append("test@test.com");
requestData.append("&user.emailOptIn=false");
requestData.append("&output=api");

URL url = new URL( sbUrl.toString() );
URLConnection conn = url.openConnection();

conn.setDoOutput( true );

OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
String data = sbData.toString();
wr.write( data );
wr.flush();

BufferedReader rd = new BufferedReader( new InputStreamReader( conn.getInputStream() ) );
StringBuffer htmlBuilder = new StringBuffer();
String line;
while ( ( line = rd.readLine() ) != null) {
htmlBuilder.append( line );
}

rd.close();
String ticket = htmlBuilder.toString().split( "<ticket>" )[1].split( "</ticket>" )[0];

}

%>
</body>
</html>

The example(s) above return the the Login Ticket which is used in the JavaScript code below.

Place the Login Ticket you retrieved from the UserService API into your setLoginTicket HTML code. For example you may output the Login Ticket value into the HTML page so it can be used by the WPCAPI.setLoginTicket to enable the logged in user to edit the "Hello World" content. The the following script includes the addition of the WPCAPI.setLoginTicket line of script in the Head section of your HTML

<html>
<head>
<script src="http://wapi.wetpaint.com/JavaScriptService/getBootstrap.do?key=<your developer key>" type="text/javascript"></script>
<script type="text/javascript">

if( window.WPCAPI ) {
WPCAPI.setDeveloperKey("507ace0d168024cbcb53a9add0e6fe4e9796012e6b420cfafabac6a4357824ef");
WPCAPI.setNamespace("sandbox-trial");
WPCAPI.processLogin = function() { location.href = "/path/to/login/page.htm"; }
WPCAPI.setLoginTicket("your-login-ticket"); // only required if user is logged in
}

</script>
</head>
<body>
...

Once this fifth step is completed, your users will be able to view, login and edit the "Hello World" content.

Step 6:

Click the Get Injected button to Sign-up for a Developer Key so you can integrate Wetpaint Injected into your own website.

HD2

boe_wetpaint — Thu, 19 Nov 2009 16:52:26 CST

There is no abstract available for this page revision.

Community Contributed Application Showcase

boe_wetpaint — Wed, 11 Nov 2009 11:21:18 CST

The community has been hard at work building creative widgets, plugins and other tools to help you add Wetpaint Injected to your website. We encourage these kinds of mashups, and have put together a showcase of developer contributed examples to share with the Wetpaint Injected community.

NOTE: The Drupal, Wordpress and vBulletin plugins are temporarily unavailable due to technical difficulties. We're working with the author and hope to have the plugin downloads restored soon.

Drupal	Wordpress	vBulletin

Description: Add an editable Wetpaint Injected content area to any Drupal page! Drupal is a content management system that allows you to organize a wide variety of content. Learn more about Drupal features here.	Description: Give your blog audience a voice by adding an editable Wetpaint Injected content area to any Wordpress blog entry or page! Wordpress is a is a state-of-the-art publishing platform with a focus on aesthetics, web standards, and usability. Learn more about Wordpress features here.	Description: Add an Injected wiki content area to your vBulletin thread summary section! vBulletin is a powerful community solution that makes it easy to add a forum messaging system to your web site. Learn more about vBulletin features here.
Author: Alexey Karpik / Dave Nielsen	Author: Alexey Karpik / Dave Nielsen	Author: Alexey Karpik / Dave Nielsen
Learn more / Download Now	Learn more / Download Now	Learn more / Download Now

NOTE: The Drupal, Wordpress and vBulletin plugins are temporarily unavailable due to technical difficulties. We're working with the author and hope to have the plugin downloads restored soon.

Microsoft ASP.NET Server Control

Description: Add an editable Wetpaint Injected content area to any Microsoft ASP.NET web page!
Author: Atilla Yadik
Learn more / Download Now

Support

The community contributed applications are here for your enjoyment and are offered as-is. To receive support for any of the featured applications, please post a message in the discussion forums, or contact the author directly. Wetpaint Injected does not offer support for community contributed applications.

How to Contribute

Have you built a cool new application or mashup that you'd like to share with the Wetpaint Injected community? Tell us about it by posting a message in the discussion thread below, or by sending a P2P to boe_wetpaint. If your application needs to be installed, then please provide a link to where we can retrieve the package. All submissions need to include installation instructions. If your application is hosted and not installed, then provide a link to where your application resides. New community contributed applications are reviewed on a regular basis. We will contact you in the event your application is selected for to be showcased, or if we've got additional questions or comments.

Sample Applications

boe_wetpaint — Wed, 11 Nov 2009 11:21:02 CST

Sample Code Library

Quick-start your integration by referencing our code sample library.

ASP.NET Sample Application
Demonstrates the use of a Custom Web Control to request user-generated content and request the client application.

JSP Sample Application
Includes examples of requesting the client application and adding user-generated content in a Java/JSP environment.

PHP Sample Application
An integration with Wordpress, which uses PHP.

Sample Wordpress Prototype

Wordpress PrototypeTo see a working example and view specific interactions, visit the Wordpress prototype.

NOTICE

boe_wetpaint — Fri, 15 May 2009 12:11:21 CDT

Environment Changes

In the past, Wetpaint Injected has supported two environments: wapi.wetpaint.com, which is our production environment, and togo.wetpaint.com, which is our sandbox environment. Starting immediately, we will no longer be issuing keys for the togo.wetpaint.com environment. Going forward, all keys issued will be for the wapi.wetpaint.com environment.

While most references to the togo.wetpaint.com environment have been removed from the wetpaintinjected.com wiki, some sample code still references this environment. In the coming weeks we will be transitioning all of our sample code to reference wapi. This change is being made to roll out our Wetpaint Injected self-serve functionality, which allows anyone to sign up for a developer key. Also, this change will simplify our documentation as everything will point to wapi.wetpaint.com.

If you wish to have multiple Wetpaint Injected environments we suggest signing up for multiple developer keys. One of your developer keys can be used to host your sandbox environment, while the other can be used for production, etc.

API Changes

Two Wetpaint Injected APIs are changing. The documentation on the Wetpaint Injected wiki has been modified to reflect the changes. The changes are:

Load Bootstrap
When loading the client application bootstrap, we now require that you provide your developer key:

For more information, please refer to the Injected integration guide.

FeedService
Production feeds are now accessible via the feed.wapi.wetpaint.com:

GET /FeedService/getRecentlyUpdatedCells.do?ns=<wiki namespace>

-- and --

GET /FeedService/getMostActiveCells.do?ns=<wiki namespace>

For more information, please refer to the FeedService API documentation.

User-Generated Pages

boe_wetpaint — Tue, 24 Mar 2009 13:08:50 CDT

User-generated pages can be added to your site. The client application controls most of the behavior; however, some methods must be overridden to fully integrate it with your site. For an explanation on how user-generated pages can be implemented, view step 5 of the integration guide.

Function Reference

String	WPCAPI.generateCellID	Override this function to generate your own cell identifiers.
String	WPCAPI.generateCellURL	Override this function to generate your own cell URLs.
boolean	WPCAPI.onpagecreate	This event is fired whenever a page is created.
boolean	WPCAPI.onpagedelete	This event is fired whenever a page is deleted.
boolean	WPCAPI.onpagerename	This event is fired whenever a page is renamed.
boolean	WPCAPI.onpagerestore	This event is fired whenever a deleted page is restored.
void	WPCAPI.showAddPageDialog	Call this function to display the Add Page dialog.

DiscussionService.createThread

boe_wetpaint — Tue, 10 Mar 2009 18:12:07 CDT

HTTP Method	URI	Returns
POST	/DiscussionService/createThread.do
Overview: Creates a new discussion thread associated to a cell.
Common Parameters Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration ticket The ticket assigned to the current logged in user cell.cellId The cell to which this thread will belong. Must be between 1 and 1000 characters post.name The name for the initial post in the thread. This name will also be used as the name of the thread. Must be between 3 and 255 characters post.content The HTML content for the initial post in the thread. Must be between 3 and 2500 characters output Currently only api output is supported for this call Optional Parameters: thread.url.pattern A URL pattern that will be used to generate a permalink to this thread once we have assigned it an id. The pattern should contain the literal placeholder ${ThreadId}, which will be replaced with the generated id. For example, if you pass http://www.yoursite.com/thread/${ThreadId}, the resulting URL for this thread will be http://www.yoursite.com/thread/12345. Or, if you pass http://www.yoursite.com/boards?t=${ThreadId}, the URL will become http://www.yoursite.com/boards?t=12345. Must be between 1 and 1000 characters.
Example Request ( required parameters in red ):
Example Response:

CellService.editCell

boe_wetpaint — Mon, 09 Mar 2009 13:42:04 CDT

HTTP Method	URI	Returns
POST	/CellService/editCell.do	The edited cell.
Overview: Updates the content of a cell. If the specified cell does not exist, then it is created. (NOTE: Currently, creating a cell through this call is the only way to specify a custom creation date.)
Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration ticket The ticket assigned to the current logged-in user cell.cellId The name of the cell to be edited cell.displayName The display name of the cell cell.url The cell’s URL cell.currentRevision.version The version of the cell being edited. If the cell is being created, then the currentRevision.version should be set to 0. revision.content The new HTML content Optional Parameters: revision.editNote Edit note revision.date Desired date and time for new revision in ISO8601 format, e.g. 2008-12-31T23:59:59-08:00. This parameter is currently only used when editing the first revision of a cell.
Example Request ( required parameters in red ): http://wapi.wetpaint.com/CellService/editCell.do ?key=yourissueddeveloperkey &ns=yourassignednamespace &cell.cellId=someCell &cell.displayName=Some%20Rad%20Cell &cell.url=http%3A%2F%2Fwww.yoursite.com%2Fmypage &cell.currentRevision.version=3 &revision.content=%3Cdiv%3ESome%20Rad%20Content%3C%2Fdiv%3E &ticket=ticketFromLogin &output=api &revision.editNote=I%20edited%20this.
Example Response: <?xml version="1.0" encoding="UTF-8"?> <response version="123456789"><cell><cellId>someCell</cellId><currentRevision><content><![CDATA[<div>Some Rad Content</div>]]></content><date>2008-10-08T10:34:58-07:00</date><deleted>false</deleted><diff><addedImages>0</addedImages><addedWidgets>0</addedWidgets><addedWords>0</addedWords><deletedImages>0</deletedImages><deletedWidgets>0</deletedWidgets><deletedWords>0</deletedWords></diff><editNote>I edited this.</editNote><type>edit</type><user><userId>IAmARegisteredUser</userId></user><version>4</version><wordCount>3</wordCount></currentRevision><deleted>false</deleted><displayName>Some Rad Cell</displayName><locked>false</locked><tags total="0" offset="0"/><url>http://www.yoursite.com/mypage</url></cell></response>

Step 3: Add User-Generated Content

boe_wetpaint — Fri, 06 Mar 2009 16:38:37 CST

Data Access API Call	CellService.getCellContent	Returns only the content of a cell.
Data Access API Call	CellService.getCell	Returns a cell's content, metadata, current revision information, and tags.

The user-generated content areas on your page can be retrieved as embedded HTML via a server-side include (SSI). The call to add user-generated content is made anonymously; i.e.you will not send us the ticket you received, described in step 1 of this guide. However, in order for your users to make edits to the content, you will need to have retrieved the ticket and provided it to the javascript client application outlined in step 2.

When you have identified where on your page you want to include user-generated content, you simply add the SSI in that location. The HTML response is contained in a <DIV> element and every ID and class used by the HTML and CSS is prefixed with "WPC" to avoid conflicts with your namespace.

Note that how you construct requests will vary depending on your platform and what frameworks you use. We have included some sample applications with code snippets to help get you started.

Two Different APIs

The two APIs (getCellContent, getCell) offer an increasing amount of data. At first, you should use getCell to retrieve as much data as possible -- this provides a "byline" for the content that includes information about the last author, a list of tags, and simple navigation to subpages. As you implement more API calls later, you can trim this request down.

Below is an example of the kind of information that can be returned with these calls.

Getting Cells Is Anonymous

These calls do not require a ticket because the call is made anonymously and no special permissions are required to view content. This allows for caching the content requests (described later in this guide).

Cells and Cell Identifiers

Every section of user-generated content, or cell, is referenced by a unique identifier. This identifier is something you make up that is meaningful to your system. When you request a cell, you must send along this unique identifier.

WYSIWYG Editing and Saving Content

Once the content is retrieved by your server and sent to the client, the client application enables WYSIWYG editing and saving of that content. To enable that functionality, refer to the next step of the Integration Guide.

Next Step 4: Customize Interface Style

CellService.getCell

boe_wetpaint — Thu, 05 Mar 2009 13:14:29 CST

HTTP Method	URI	Returns
GET	/CellService/getCell.do	A cell, including cell metadata, the cell's current revision, and its tags.
Overview:Retrieves the current revision of a cell. This call returns user-generated HTML content, details about the last edit, and tags. The default output of this call returns HTML suitable for a server-side include.
Common Parameters plus... Required Parameters: cell.cellId The cell to fetch. cell.displayName The default cell display name to return if the cell specified by cell.cellId does not currently exist. If the cell exists, this parameter is ignored. This parameter may safely be ignored if all cells are being explicitly created. cell.url As cell.displayName, the default cell URL to return if the specified cell does not exist. If the cell exists, this parameter is ignored. This parameter may safely be ignored if all cells are being explicitly created. Optional Parameters: cell.templateId If specified and the cell has no content, the response will include the content of the specified template. cell.currentRevision.version If specified and the cell is currently at this version, the response will include no cell content. cell.children.detail If set, returns child cell details. Valid values are: none - (default) Returns no child cell-level detail. count - Returns count of child cells. ref - Returns reference to child cells. cell.threads.detail If set, returns associated cell discussion threads. Valid values are: none - (default) Returns no discussion thread-level detail. count - Returns count of threads. full - Returns full thread level detail.
Example Request ( required parameters in red ): http://wapi.wetpaint.com/CellService/getCell.do ?key=yourissueddeveloperkey &ns=yourassignednamespace &cell.cellId=someCell

CellService.getCellWithChildren

boe_wetpaint — Tue, 03 Mar 2009 18:27:31 CST

Call deprecated.

This API call has been superseded and use should be avoided. For similar functionality, please see CellService.getCell. For cell children detail, please see parameter cell.children.detail.

HTTP Method	URI	Returns
GET	/CellService/getCellWithChildren.do	A cell, including cell metadata, the cell's current revision, its tags, and its children.
Overview: Retrieves the current revision of a cell. This call returns user-generated HTML content, details about the last edit, tags, and a list of child cells.The default output of this call returns HTML suitable for a server-side include.
Common Parameters plus... Required Parameters: cell.cellId The cell to fetch. cell.displayName The default cell display name to return if the cell specified by cell.cellId does not currently exist. If the cell exists, this parameter is ignored. This parameter may safely be ignored if all cells are being explicitly created. cell.url As cell.displayName, the default cell URL to return if the specified cell does not exist. If the cell exists, this parameter is ignored. This parameter may safely be ignored if all cells are being explicitly created. Optional Parameters: cell.templateId If specified and the cell has no content, the response will include the content of the specified template. cell.currentRevision.version If specified and the cell is currently at this version, the response will include no cell content.
Example Request ( required parameters in red ): To add...

CellService

boe_wetpaint — Tue, 03 Mar 2009 18:19:20 CST

The CellService provides functionality for retrieving, editing, and moderating content areas, or cells.

Retrieving cells

Editing cells

Retrieving and editing cell history

Deprecated calls

CellService.getCellWithChildren

CellService.moveCell

boe_wetpaint — Thu, 26 Feb 2009 16:43:13 CST

HTTP Method	URI	Returns
POST	/CellService/moveCell.do	A cell, including cell metadata, the cell's current revision, and its tags.
Overview: Move a cell to a new location – specified by cell.parentCellId – optionally specifying the cell order by providing either insertBeforeCellId or insertAtCellIndex. By default, the cell is inserted at the last position.
Common Parameters Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration ticket The ticket assigned to the current logged-in user cell.cellId The cell being moved output Currently only api output is supported for this call cell.parentCellId The new parent cell. If passed as an empty string, the cell is orphaned Optional Parameters: insertBeforeCellId The cell id of the desired following cell insertAtIndex Requested new index for the cell. If 0, the cell is inserted at the first position
Example Request ( required parameters in red ):
Example Response:

CellService.getCellChildren

boe_wetpaint — Thu, 26 Feb 2009 16:38:32 CST

HTTP Method	URI	Returns
GET	/CellService/getCellChildren.do	A list of the specified cell's child cells.
Overview: Retrieves the children for a given cell.
Common Parameters Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration cell.cellId The cell to find the children of output Currently only api output is supported for this call Optional Parameters: cell.detail The detail level of the child cells returned. May have the values ref (default) or full cell.children.detail The detail level of the children collection on each of the child cells returned. May have the values none or count (default) cell.threads.detail The detail level of the threads collection on each of the child cells returned. May have the values none (default) or count offset Starting result number. Defaults to 0 if unspecified maxResults Number of results to return. Defaults to 50 if unspecified
Example Request ( required parameters in red ): http://wapi.wetpaint.com/CellService/getCellChildren.do ?key=yourissueddeveloperkey &ns=yourassignednamespace &cell.cellId=someCellWithChilren &output=api
Example Response: <response version="Response_Version"> <cells total="x"> <cell> <cellId>CellId</cellId> <creationDate>Date of cell creation</creationDate> <currentRevision> <content>![CDATA[HTML document]]</content> <date>Date of cell revision</date> <deleted>Is revision deleted</deleted> <editNote>EasyEdit note for current version</editNote> <type>Revision Type</type> <user> <displayName>Display Name of User</displayName> <profileUrl>Profile URL of User</profileUrl> <userId>UserId for user</userId> </user> <version>Revision Version Number</version> <wordCount>Word count for revision</wordCount> </currentRevision> <deleted>Is cell deleted</deleted> <displayName>Cell display name</displayName> <locked>Is cell locked?</locked> <tags total="x" offset="x"> <tag> <name>tag 1 value</name> </tag> ... </tags> <url>cell URL</url> </cell> ... </cells> </response>

API Reference

boe_wetpaint — Thu, 26 Feb 2009 16:04:56 CST

Within this section lies every available API that you can call to interact with Wetpaint Injected. The Integration Guide explains how and why these APIs are designed to be used. The features and functionality guide (PDF) describes the capabilities in detail.

Client Application
The Javascript library contains many hooks that allow you to control the appearance and functionality of the user experience.

Data Access APIs
Your server can directly access these API calls, allowing you access to user controls, user-generated content, and more.

Glossary
A list of terms we use in this documentation and their definitions.

Index
An alphabetical listing of every method and call available.

Bugs & Issues

If you encounter a feature that is not working as advertised here, add a bug report so we can fix the issue.

DiscussionService.deletePost

boe_wetpaint — Thu, 26 Feb 2009 16:04:39 CST

HTTP Method	URI	Returns
POST	/DiscussionService/deletePost.do
Overview: Deletes a discussion thread. This operation requires moderator permissions.
Common Parameters Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration ticket The ticket assigned to the current logged-in user. Must have moderator privileges thread.threadId The thread where the post exists post.number The post to delete output Currently only api output is supported for this call
Example Request ( required parameters in red ):
Example Response:

DiscussionService.deleteThread

boe_wetpaint — Thu, 26 Feb 2009 16:04:29 CST

HTTP Method	URI	Returns
POST	/DiscussionService/deleteThread.do
Overview: Deletes a discussion thread. This operation requires moderator permissions.
Common Parameters Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration ticket The ticket assigned to the current logged-in user. Must have moderator privileges thread.threadId The thread to delete output Currently only api output is supported for this call
Example Request ( required parameters in red ):
Example Response:

DiscussionService.createPost

boe_wetpaint — Thu, 26 Feb 2009 16:04:17 CST

HTTP Method	URI	Returns
POST	/DiscussionService/createPost.do
Overview: Adds a new post to an existing discussion thread.
Common Parameters Required Parameters: key The developer key. This value is provided by Wetpaint during initial developer registration ns The content namespace. This value is provided by Wetpaint during initial developer registration ticket The ticket assigned to the current logged-in user thread.threadId The thread to which this post will belong post.name The name for this post. Must be between 1 and 255 characters post.content The HTML content for this post. Cannot be longer than 5000 characters. output Currently only api output is supported for this call Optional Parameters: post.url.pattern A URL pattern that will be used to generate a permalink to a shell page that contains the list of posts containing the new post. Should contain either a literal ${Offset} or ${PageNumber} placeholder (but not both), depending on your URL scheme. For an offset-based URL scheme, if you pass a post.url.pattern of http://yoursite.com/boards/1234/thread/1234?start=${Offset} and a post.url.maxResults of 10, and the new post is the 45th in this thread, the resulting permalink URL will be http://yoursite.com/boards/1234/thread/1234?start=40. For a page-number-based URL scheme, if you pass a post.url.pattern of http://yoursite.com/boards/1234/thread/1234?page=${PageNumber} and a post.url.maxResults of 10, and the new post is the 45th in this thread, the resulting permalink URL will be http://yoursite.com/boards/1234/thread/1234?start=5. Note on numbering: the numbering of posts begins at 1, the offset-based scheme is zero-based, and page-number-based scheme is one-based. So, still assuming a maxResults value of 10, the 20th post’s URL would become http://yoursite.com/boards/1234/thread/1234?start=10 in the offset-based scheme and http://yoursite.com/boards/1234/thread/1234?start=2 in the page-number-based scheme. Must be between 1 and 1000 characters. post.url.maxResults The page size (the number of posts on the shell page). Required if you have included either the ${Offset} or ${PageNumber} placeholder in the passed post.url.pattern. Used to calculate the offset or page number for the post’s permalink.
Example Request ( required parameters in red ):
Example Response: