ScreenTweet Developer API
API Documentation
Welcome
Welcome to the ScreenTweet Developer API. With our API you can build dynamic applications using the ScreenTweet.com service. The ScreenTweet API is currently beta. We welcome new developers and value your feedback. Post your feedback at the screentweet forums.
Get Started
To get started using the API, you must first get an API Key.
How it works
API Methods
The following methods are available through the API:
uploadAndPost Method
getScreentweetThumbnail Method
getUserThumbnail Method
XML Error Codes
uploadAndPost Method
The uploadAndPost Method allows you to post pictures, tweets, audio, and more to ScreenTweet. It mimics the upload process on ScreenTweet.com.
To call this method you must post to the url
Required fields are indicated in bold and an asterisk (*).
To call this method you must post to the url
http://screentweet.com/api/uploadandpost/ using your API Key.
Important: Make sure you use the HTTP-POST method with multipart/form-data encoding type.
Required fields are indicated in bold and an asterisk (*).
| Field name | Format | Description | Example |
|---|---|---|---|
| apikey* | - | Your Provided API Key | xxxxxxxxx |
| message* | 108 characters | Message to be tweeted with post | Screentweet.com is cool! |
| image* | .jpg, .png, .bmp, .gif | Image File | <jpg file> |
| uname* | 32 characters | User Name | testuser |
| upass* | 32 characters | User Password | testpassword |
| arrowloc | [on/off]:[x]:[y] | Arrow location (Arrow on/off and x and y coordinates) | on:40:50 |
| tags | Comma separated list | Tags | screentweet, images, photos, videos |
| audio | .mp3 audio file | Audio File | <mp3 file> |
| privacy | [private/public] | Make this ScreenTweet private (default:public) | private |
Example XML Response:
Success:
<rsp stat="ok">
<id>[id]</id>
<author>[username]</author>
<shorturl>http://scr.tw/[id]</shorturl>
<longurl>http://screentweet.com/[id]/[message (formatted)]</longurl>
<message>[message]</message>
<tags>[tags]</tags>
<privacy>[privacy]</privacy>
</rsp>
getScreentweetThumbnail Method
The getScreentweetThumbnail Method is simply a url to an image.| URL | |
|---|---|
http://screentweet.com/st/[id]/tn_[size].jpg |
|
| name | description |
| id | id of screentweet (7 character alphanumeric key in screentweet url) |
| size | size (small, medium, large) |
Example:
Code:
Result:
JPEG Image
http://www.screentweet.com/st/ac3cjCa/tn_small.jpg
Result:
JPEG Image
getUserThumbnail Method
The getUserThumbnail Method is simply a url to an image.| URL | |
|---|---|
http://screentweet.com/gi/[username]/ |
|
| name | description |
| username | username of screentweet user |
Example:
Code:
Result:
JPEG Image
http://www.screentweet.com/gi/screentweet/>
Result:
JPEG Image
XML Error Codes
Every request will pass back an XML Response in the following format:Success:
<rsp stat="ok">
[additional xml]
</rsp>
Failure
<rsp stat="fail">
<err code="[code]" msg="[message]" />
</rsp>
Error codes and messages
1001 Request must be made by HTTP-POST
1002 Invalid API Key
1003 Invalid Username or Password
1004 Invalid Password
1005 Invalid Request
1006 Invalid File
1007 Error processing XML
1008 Twitter service unavailable
2001 Message longer than maximum 108 characters
2002 Invalid filetype for image
2003 Image file exceeds size limit
2005 Error uploading image
2006 Invalid value for Arrow
2007 Cannot add Arrow
3001 Invalid filetype for audio
3002 Audio file exceeds size limit
3003 Invalid audio file
3004 Error uploading audio
HTTP Error codes
404 Not Found
500 API is unavailable
Post your feedback at the screentweet forums.
