Developers: Get a head start with our Hello World Tutorial wiki!

Wetpaint Injected allows any website to incorporate Wetpaint features. Implementing Wetpaint Injected requires access to your server pages and some basic web API programming skills. Wetpaint Injected APIs are RESTful and can be accessed from many programming languages. Wetpaint provides sample code in Java, PHP and .NET.

Three types of interface formats are available that allow direct access to Wetpaint Injected content and user data. You may mix and match these methods throughout a site.

Note: Before you get started, you must download and review the Interaction Guide. It will give you a basic understanding of the features and functionality made available by Wetpaint Injected.

To easily allow search engine access to your user-generated content, server-side includes apply browser-ready HTML to your server pages. Because the content is rendered with the rest of your page, it may be crawled and indexed by search engines, which then attribute the content to your domain. The HTML content returned by this API may also include the user controls and JavaScript necessary to engage the Wetpaint Injected interactive capabilities, such as the Wetpaint WYSIWYG Content Editor. Standard server-side include snippets provide the quickest and easiest option for most developers to integrate Wetpaint Injected capabilities.

Data access calls can be made from your server-side code, providing you with access to granular features and data. Using RESTful commands, your data can be created, retrieved, updated, or deleted programmatically. The response from these calls is XML. These calls offer you the greatest flexibility of all interfaces, but require more developer effort to integrate. Most calls to the data access API will be made on behalf of an end user. For example, the following types of calls provide access control appropriate to the signed in state and level of permissions of a user: retrieve and edit content, retrieve reputation data associated with a user account, or interact with the Wetpaint Injected social feature set. A small number of API calls, such as to authenticate users, will be system-level calls. Such calls must be made from your server and require additional security parameters.

A collection of public methods and event handlers are made available from the Wetpaint Injected JavaScript Library. These methods provide your own JavaScript access to the Wetpaint Injected client application. By accessing these methods, you are able to affect the appearance and functionality of the user experience. All JavaScript executed on your pages is contained within a restricted namespace to avoid variable collision. The initial payload includes only a minimum set of functionality to ensure timely loading of your web pages; additional code is retrieved on-demand as the user interacts with the client application.

The following steps will help you get started with a basic Wetpaint Injected integration. For complete details, download the Interaction Guide.

A developer key is required to complete your Wetpaint Injected integration. Email us to get your your API key. We will respond to you quickly. When you receive your developer key, you will add it to your server page to enable it to communicate with Wetpaint. While you are waiting for your API Key, you can download the Interaction Guide, review the details, and continue with Steps 2 and 3.

Add the Server-Side Include (SSI) to your server page, it will import a URL which retrieves the user-generated content cell and places it on your page.

Add our JavaScript code in the header of your page. This code initializes the client application in your web page. Through this code, your site will offer WYSIWYG editing of user-generated content.