MobileTribe WS API v1.0February 10, 2010
MT Logo

Mobile Tribe Live API

Welcome to the Mobile Tribe's Live API site. This page serves as the test portal for the MT API intended for use by developers writing clients against the API. From here you can see the full set of features and operations supported in the API and for each, manually execute the operation using a custom form.

The MobileTribe WS protocol is a pseudo-REST protocol using the URL form:

http://host.mobiletribe.net/ws?PARAMETERS

where PARAMETERS are & separated NAME=VALUE pairs:

feature=FEATURE
The feature name, such as addressbook, alerts, friends, messages, or pictures.
operation=OPERATION
The operation name. Operations are specific to features. For example, for the messages feature, some of the operations are DeleteMessage, DeleteSWB, GetMessage, or SendMessage.
portal=PORTAL
The portal name, such as bliptv, facebook, google, jajah, multimedia, myspace, orb, orkut, plaxo, yahoo, or youtube.
version=VERSION
Optional version number. Default is 1.
skipimages=true|false
Optional attribute that controls the embedding of images. If this attribute is omitted or if its value is false (the default), then images are embedded and returned in the response XML. For example, an image will be Base-64 encoded and embedded as: 
         <image>
         /9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAZAAA/+4ADkFkb2JlAGTAAAAA
         Af/bAIQAAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQICAgIC
         ...
         </image>
If, the attribute is present and its value is true, then all images are instead written to an Image cache, and only their URLs are returned in an attribute imageURL in the image elements, as in 
        <image imageURL="http://demo.mobiletribe.net/wsImages/mt023947622.png"/>
To obtain the images, the client has 5 minutes to retrieved the images separately from the specified URL. After 5 minutes, the images are removed from the cache.
MT-Application-Key=APP-KEY
The application key. This parameter is optional in the URL. If omitted, the application key must be provided as a request header. To obtain, an application key, contact support@mobiletribe.net.
NAME=VALUE
Zero or more name/value pairs specific to the Feature/Operation.

The input arguments and the XML result schemas are defined by the Feature/Operations XSD files defined in http://schemas.mobiletribe.net/. The specific files are accessed as:

http://schemas.mobiletribe.net/FEATURE/FEATURE-OPERATION-VERSION.xsd

All feature, operation, and portal names are case sensitive, as shown in the table.

GET vs. POST

For most requests, a URL with all the parameters sent as a GET method is sufficient. When parameter values are large, an alternative is to use the POST method and move the parameters with long values into the POST body.

  <mt_request>
    <description>
      Thwas Brilling and the slity Toves
      Did Gimble and Gyre in the Vabe.
      All Mimsy were the Borogoves, and the
      Mome hast Outgrabe....
    </description>
  </mt_request>

The feature, operation, portal, and version parameters MUST appear in the URL. All other parameters may appear in either the POST body or the URL.

Data Encoding

All images are either JPG or PNG Base64 encoded. Refer to external documentation for details.

Authorization

The MT WS Proxy maintains a session for each portal being accessed. To obtain a portal session, the client has to authenticate to the requested portal in the first request and then use the provided session id in subsequent requests to the portal.

On a first request to a portal, the client has to include the portal's userid/password as BASIC authorization in the HTTP header attribute Authorization. The response will contain the JSESSION cookie in the Set-Cookies response header attribute. The client should then include the session cookie in all subsequent requests to the portal in the Cookie header attribute.

More Information

For more information on MobileTribe, its services, and the WS API, visit

www.mobiletribe.net

Copyright 2008, 2009, Mobile Tribe Inc., All Rights Reserved.

Features and Operations

Click on the operation to see the operation's request arguments.

Feature addressbook

Feature blog

Feature friends

Feature messages

Feature multimedia

Feature newsfeed

Feature notifications

Feature pictures

Feature upload

Feature video

Feature voice

Copyright 2008, 2010, MobileTribe Inc., All Rights Reserved.