There are currently two types of access to the Upingme API: 'No Account Simple Access' and 'Account Revenue Share'. They run like this:
No Account Simple Access
5 Most Recent Messages
Point your client at this API URI, and have the 5 most recent messages returned:
http://www.upingme.com/api/simple.xml
The server will respond with a list of 5 results like this:
<upingme_package>
<object>
<id>9</id>
<magic_number>an568</magic_number>
<uri>http://www.upingme.com/an568</uri>
<message>I have a new and boxed Dualit toaster to sell with guarantee- an unwanted gift.
I will take €23 cash. You can collect from my Rome office 9 - 5. msg me!</message>
<timestamp>1193664313</timestamp>
<location="Bar Escoba 112 East Vanessa Str Vlissigen"</location>
</object>
...
...
</upingme_package>
Retrieve a Number's Location
Point your client at this API URI, and have the location of a number returned:
http://www.upingme.com/api/location/00121234567891
N.B. All numbers in Upingme start with '00' followed by the country code, then the operator prefix, then the user number, without spaces.
If the number your client tries to retrieve fails, error code '404' is returned:
<upingme_package mode="location">
<location>404</location>
</upingme_package>
If the user has their privacy turned on, you get returned 'nowhere':
<upingme_package mode="location">
<location>Nowhere</location>
<nickname>irdial</nickname>
<icon>http://www.upingme.com/thumbnails/24.jpg</icon>
</upingme_package>
Otherwise, the magic is working:
<upingme_package mode="location">
<location>727 5th ave new York by 10022</location>
<nickname>feral_nutz</nickname>
<timestamp>1196876518</timestamp>
<icon>http://www.upingme.com/thumbnails/1.jpg</icon>
</upingme_package>
and you are returned the number's location, the time they got there, and the URI to their icon.
Retrieve a number's Frenzy code
Point your client at this API URI, and have a user's Frenzy code, currency and Frenzy balance returned:
http://www.upingme.com/api/frenzy/00121234567891
The server will respond with this:
<upingme_package>
<upingme_package mode="frenzy">
<frenzy_code>lmw94</frenzy_code>
<frenzy_balance>0</frenzy_balance>
<currency>£</currency>
</upingme_package>
Account Access Revenue Share (T.B.A.)
To use the Upingme API with an API account, you supply the server with your API key, your password and a keyword in an HTTP request, like this:
http://www.upingme.com/api.php?key=<your API key>&password=<your password>&keyword=<a tag>&results=<the number of results you want returned>
The server will respond with a list of results like this:
<upingme_package>
<object>
<id>9</id>
<magic_number>an568</magic_number>
<uri>http://www.upingme.com/an568</uri>
<message>I have a new and boxed Dualit toaster to sell with guarantee- an unwanted gift.
I will take €23 cash. You can collect from my Rome office 9 - 5. msg me!</message>
<location="Bar Escoba 112 East Vanessa Str Vlissigen"</location>
<timestamp>1193664313</timestamp>
</object>
</upingme_package>
There are obviously some cool things you can do with these Upingme Packages, like squirting the 'location' information into an online mapping service to show where Upingme things are taking place. Account holders will be able to revenue share with us where we split the money we receive from billable texts that are replied to via referrals to Upingme from your site. API account holders can also control the tag queries that are sent to the API and the number of results to be returned.
The Upingme API is in development. We are adding calls so that you can retrieve more data from our DB. It will all be RESTful. Your feedback has been useful; feedback helps us improve the API and provide just what developers need.