This document describes how to create a LetsProve platform application which you can use as a example when creating your own application. To create new application, go to My Account > Developer > Set up new Application
Platform Parameters
Platform Parameters begin with '%' follow by parameter's name. You can use these parameters in Data URL, Text Format and Post to Message Text Format.
Example
The Platform parameters are the input parameters (both required and optional), data in Each data Tag.
Here are the example Data feed from twitter user timeline API.
<statuses type="array">
<status>
<created_at>Sat May 03 06:47:03 +0000 2008</created_at>
<id>802451204</id>
<text>
Hello Test photo
</text>
<source>web</source>
<truncated>false</truncated>
<in_reply_to_status_id/>
<in_reply_to_user_id/>
<favorited>false</favorited>
<user>
<id>8705172</id>
<name>letsprove</name>
<screen_name>letsprove</screen_name>
<location/>
<description/>
<profile_image_url>
http://static.twitter.com/images/default_profile_normal.png
</profile_image_url>
<url/>
<protected>false</protected>
<followers_count>4</followers_count>
</user>
</status>
</statuses>
Input data: username (ex. letsprove)
The Data URL: http://twitter.com/statuses/user_timeline/%username.xml
Primary key: id (the name of tag which contain primary key)
Each data Tag: status (the name of tag which contain every data rows)
Example Text Format:
posted %text on <a href="http://twitter.com/%username" target="_blank">Twitter</a>
Example Post to Message Text Format:
You post message from %username on Twitter
Platform parameters:
%username = letsprove
%created_at = Sat May 03 06:47:03 +0000 2008
%id = 802451204
%text = Hello Test photo
%truncated = false
%in_reply_to_status_id = NULL
%in_reply_to_user_id = NULL
%favorited = false
Fields description
-
Application Name
Your application name. ex: 'My first app'
-
Category
Your application category.
-
Icon
Your application icon, size 16x16 px.
-
Description
Your application description.
-
Website
Your application website which contain more information about your service.
-
Data URL
The URL which contain XML data of activities from your service. ex. http://myservices.com/xml/activities/%username
-
Profile URL
The personal URL for your users. ex. http://myservices.com/%username
-
Primary key
The tag name which is unique key to saparate every activities from your service.
-
Each data Tag
The Tag name to saparate every datas from your service.
-
Required HTTP basic authentication
See article from Wikipedia
-
Method
The Request methods. See Hypertext Transfer Protocol
-
Required Parameters
Required parameters for you service (ex. username, password). These parameters will be prompted when use adding your application.
-
Optional Parameters
Optional parameters for you service (ex. page, city). These parameters will be prompted when use adding your application.
-
Text Format
The activities text format of your service, HTML are enable. ex. posted a message on Twitter - %text.
-
Enable notification
To enable your application to automatically send a direct message to user when it has new activity.
-
Post to Message Text Format
The text format of your notification message (Send user a direct message).
-
Logo
Your application logo, show in application directory and info.
-
Developer Name
-
Developer Description
-
Instruction
Instuction for user about this service, users will read this before adding your application.