TaggyText API Docs

The API uses HTTP and all method arguments are HTTP POST.

User authentication

Methods
write
read
pluck
edit
delete
canEdit
login
myNames

Response Formats
XML

User Authentication

Many methods accept user authentication variables. Send an HTTP POST uid and upass where uid is the user's account email and upass is an md5 hash of the user's TaggyText account password. These two arguments are listed on methods that use authentication.

/write

This method adds a post to TaggyText. Authentication is required if the name is owned.

URL: http://api.taggytext.com/write

Arguments:
tag: The tag to post to.
name: The name to post as.
message: The post content.
uid: Optional - User's account email address for authentication.
upass: Optional - Md5 hash of user's account password for authentication.

Error Codes:
10:Missing args - Need to send HTTP POST tag, name and message.
20:Invalid tag - tag: 1-40 chars, [a-zA-Z0-9_-].
30:Invalid name - name: 1-20 chars, [a-zA-Z0-9_-].
40:Invalid message - message arg must be 1-180 characters.
50:Blocked tag - Sent tag arg is not allowed.
101:Server error - There was an internal error with TaggyText.
102:Invalid authentication - User authentication was required and failed.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
    <messageid>Xjw8M23MQxh8K44beyP9</messageid>
</rsp>

/read

Use this method to read posts by tag and name(s).

URL: http://api.taggytext.com/read

Arguments:
tag: The tag to read posts from.
names: Optional - Comma separated list of names to filter for.
page: Optional - The offset from which to begin retrieving posts. Default is 1.
perpage: Optional - The number of posts returned. Default is 20. Range is 1 to 200.

Error Codes:
10:Missing args - A tag arg is required.
101:Server error - There was an internal error with TaggyText.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
    <messages page="1" pages="4" perpage="20" total="77">
        <message>
            <messageid>Xjw8M23MQxh8K44beyP9</messageid>
            <tag>BestFood</tag>
            <name>sara</name>
            <mess>Mexican & Chinese</mess>
            <adddate>1203946642</adddate>
        </message>
        ...
    </messages>
</rsp>

/pluck

Read posts by messageid(s).

URL: http://api.taggytext.com/pluck

Arguments:
messageids: Comma separated list of messageids.
page: Optional - The offset from which to begin retrieving posts. Default is 1.
perpage: Optional - The number of posts returned. Default is 20. Range is 1 to 200.

Error Codes:
10:Missing args - A messageids arg is required.
101:Server error - There was an internal error with TaggyText.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
    <messages page="1" pages="1" perpage="20" total="3">
        <message>
            <messageid>c2BR678r45CzA3Dkk88W</messageid>
            <tag>chat0033a345</tag>
            <name>Bill</name>
            <mess>Are you serious..weird</mess>
            <adddate>1204946111</adddate>
        </message>
        ...
    </messages>
</rsp>

/edit

Edit a message.

URL: http://api.taggytext.com/edit

Arguments:
messageid: The messageid of the post to edit.
message: The new content that will replace the existing message.
uid: User's account email address for authentication.
upass: Md5 hash of user's account password for authentication.

Error Codes:
10:Missing args - messageid and message args are required.
21:Invalid message ID - No message that matches sent messageid.
40:Invalid message - message arg must be 1-180 characters.
41:Anonymous message - Not posted by logged in user; can't be edited.
101:Server error - There was an internal error with TaggyText.
102:Invalid authentication - User authentication failed.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
</rsp>

/delete

Delete a message.

URL: http://api.taggytext.com/delete

Arguments:
messageid: The messageid of the post to delete.
uid: User's account email address for authentication.
upass: Md5 hash of user's account password for authentication.

Error Codes:
10:Missing args - A messageid is required.
21:Invalid message ID - No message that matches sent messageid.
41:Anonymous message - Not posted by logged in user; can't be deleted.
101:Server error - There was an internal error with TaggyText.
102:Invalid authentication - User authentication failed.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
</rsp>

/canEdit

Determine if a user can edit a set of messages. The comma separated list of 0's and 1's returned corresponds to the list of messageids originally sent. 1 indicates they can edit the message.

URL: http://api.taggytext.com/canedit

Arguments:
messageids: Comma separated list of messageids.
uid: User's account email address for authentication.
upass: Md5 hash of user's account password for authentication.

Error Codes:
10:Missing args - A messageids is required.
101:Server error - There was an internal error with TaggyText.
102:Invalid authentication - User authentication failed.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <bits>1,1,1,0,0,1</bits>
</rsp>

/login

Authenticate a user. Determine if a uid and upass are correct. An empty success response indicates a valid login.

URL: http://api.taggytext.com/login

Arguments:
uid: User's account email address for authentication.
upass: Md5 hash of user's account password for authentication.

Error Codes:
101:Server error - There was an internal error with TaggyText.
102:Invalid authentication - User authentication failed.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
</rsp>

/myNames

Returns all owned names for a user.

URL: http://api.taggytext.com/mynames

Arguments:
uid: User's account email address for authentication.
upass: Md5 hash of user's account password for authentication.

Error Codes:
101:Server error - There was an internal error with TaggyText.
102:Invalid authentication - User authentication failed.

Example XML Response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <ttname>
    <tag>musicMix</tag>
    <name>Julie</name>
    <expirationdate>1217746151</expirationdate>
  </ttname>
  ...
</rsp>

XML Format

A successful XML response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
    [payload]
</rsp>

A failed XML response:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="fail">
    <err code="[error code]" msg="[error message]"/>
</rsp>

Contact | API | TOS | Privacy

a Ferguson Software project