The Friendster Developer Platforms provide APIs to access Friendster data and seamless integration points within the Friendster web site to create compelling applications for Friendster's userbase.

Platform V1 and the common integration points are described in the following sections of this page.

Platform V1 APIs provides access to Friendster data through a rich REST-style interface. These resources can be accessed using an API key and a shared secret key that is issued to every application or 'Friendster App'. The resources can be accessed at the endpoint http://api.friendster.com/v1

The current list of resources supported by the platform is as follows:

The following are the current integration points within the Friendster website:

For more information about the Friendster Developers Platform, email developersupport@friendster.com.
To register your app, click here.

App developers provide the following information to get listed in Friendster's Game Portal and to get an API Key and API Secret to access Friendster data:

Friendster provides the following keys which are used for every API call:

Every API request should have the following attributes:

Example:

For instance for the following request:

http://api.friendster.com/v1/user/57519?
api_key=2e37638f335f0545c3719d34f4d20ed0&
session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
nonce=326233766.3425

The signature is computed as follows, shown here in PHP syntax:

md5(
  '/v1/user/57519' .
  'api_key=2e37638f335f0545c3719d34f4d20ed0' .
  'nonce=326233766.3425' .
  'session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519' .
  '<secret_key>');

The Canvas Page is accessed through the Canvas URL which is a public URL which uniquely identifies the app. It accepts the app name:

'http://www.friendster.com/play/<app_name>'

All references within Friendster use the Canvas URL.

The Callback URL is called with the following parameters:

Example:

For instance the following Canvas URL for the app 'slideshow':

http://www.friendster.com/play/avatarstore/show1?view=mostrecent&instance_id=3745

The Callback URL 'http://mydomain/apps/1445' would be called as follows within the App Canvas page:

http://mydomain/apps/1445/show1?
  view=mostrecent&
  instance_id=3745&
  user_id=57519&
  api_key=2e37638f335f0545c3719d34f4d20ed0&
  api_domain=api.friendster.com&
  sandbox=false&
  signed_keys=view,instance_id,user_id,api_key,api_domain,sandbox,signed_keys,src,session_key,expires,lang,nonce&
  src=profile&
  session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
  expires=0&
  lang=en-US&
  nonce=326233766.3425&
  sig=012345678901234567890123456789012

The signature is used to verify that a http request sent to the Friendster API indeed came from your application. To start we will need use the /v1/user call as an example:

http://api.friendster.com/v1/user/3448717?
nonce=177620106727976&api_key=ae17c149bedab7ecf731075eb14934a7&
session_key=b2abf542-9a5e-168c-6b29-4978de11c772

let us also assume the following:

api key: ae17c149bedab7ecf731075eb14934a7
api secret: b93d67ad280ab7bbe6fcd0197cbbc191

In order to compute for the signature correctly you need to do the following steps:

• Extract the path from the url, remove the protocols and the domain:

• Extract all the parmeters including the '=' sign, also if a parameter is URL encoded they should be unencoded during this computation.

  session_key=b2abf542-9a5e-168c-6b29-4978de11c772
  api_key=ae17c149bedab7ecf731075eb14934a7
  nonce=177620106727976

• Sort those parameters in alphabetical order

  api_key=ae17c149bedab7ecf731075eb14934a7
  nonce=177620106727976
  session_key=b2abf542-9a5e-168c-6b29-4978de11c772

• concatenate the path and the parameters together

• concatenate your secret key at the end and then compute for the md5

  md5(/v1/user/3448717
  api_key=ae17c149bedab7ecf731075eb14934a7
  nonce=177620106727976
  session_key=b2abf542-9a5e-168c-6b29-4978de11c772b93d67ad280ab7bbe6fcd0197cbbc191)
  signature => cf0e0334e5aa4d6f16e9ba038252385a

• Set the value to sig and add it to your final url request

  http://api.friendster.com/v1/user/3448717?
  nonce=177620106727976&api_key=ae17c149bedab7ecf731075eb14934a7&
  session_key=b2abf542-9a5e-168c-6b29-4978de11c772&
  sig=cf0e0334e5aa4d6f16e9ba038252385a

Examples

Sample # 1:

api key: 370d00bfb0217e651b29891d09a201b0
api_secret: 783a78da225de83c7169c32ef62193c7
sample url: http://api.friendster.com/wallet/sandbox_authenticate?
api_key=370d00bfb0217e651b29891d09a201b0&
request_token=ed836ef9e96c1466315b42ce866360&
return_url=http%3A%2F%2Fwww.friendster.com

concatenated string:

final URL with Signature

http://api.friendster.com/wallet/sandbox_authenticate?api_key=370d00bfb0217e651b29891d09a201b0&
request_token=ed836ef9e96c1466315b42ce866360&
return_url=http%3A%2F%2Fwww.friendster.com&
sig=62a2519e7544cae6c84ed8c3422822d7

Friendster has a page where you can redirect to in order to let users share your app to their friends. The URL syntax is as follows:

http://www.friendster.com/app_share/show?api_key=e59ff97941044f85df5297e1c302d260&
next=http://www.google.com

Also, when a user accepts the game invite, they will be redirected to your game play page with the referrer_uid parameter passed to your callback_url (e.g. www.friendster.com/play/mygame?referrer_uid=34245542)

The following parameters are accepted:

Sample Usage:

<a target="_blank" href="http://www.friendster.com/app/share?api_key=6b9569e1a8074ebf972aa9eb2d725f9e
&next=http://smackaho.st:8080/play/avatarstore">Share this app to your friends</a>

Get User Information

Resource URL: http://api.friendster.com/v1/user/<UID> or http://api.friendster.com/v1/user?uids=<UIDS>

Resource Methods: GET (Retrieval of user information) : POST (Retrieval of user information)

Resource Description: API to get information on one or more avatars. If no avatar ID is specified, information about current logged in avatar will be returned.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/user/57519?
    api_key=2e37638f335f0545c3719d34f4d20ed0&
    session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
    nonce=326233766.3425&
    sig=012345678901234567890123456789012

http://api.friendster.com/v1/user?uids=57519&
    api_key=2e37638f335f0545c3719d34f4d20ed0&
    session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
    nonce=326233766.3425&
    sig=012345678901234567890123456789012

Example Response (XML) :

<?xml version="1.0" encoding="UTF-8" ?>
<user_response xmlns="http://api.friendster.com/v1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://api.friendster.com/v1/friendster.xsd">
    <user>
        <uid>635423412</uid>
        <first_name><![CDATA[John]]></first_name>
        <last_name><![CDATA[doe]]></last_name>
        <url>http://profiles.friendster.com/635423412</url>
        <primary_photo_url>http://photos.friendster.com:81/photos/43/09/45345/1_620223562m.jpg</primary_photo_url>
        <location>
            <country>US</country>
            <state>CA</state>
            <city>California</city>
        </location>
        <hometown><![CDATA[san francisco]]></hometown>
        <user_type>Normal</user_type>
        <fan_profile_type>None</fan_profile_type>
        <fan_profile_category>None</fan_profile_category>
        <relationship_status>Single</relationship_status>
        <gender>Male</gender>
        <member_since>
            <year>2003</year>
            <month>02</month>
        </member_since>
        <interested_in list="true">
            <interest>Friends</interest>
            <interest>Activity Partners</interest>
        </interested_in>
        <occupation><![CDATA[Programmer]]></occupation>
        <companies></companies>
        <hobbies_and_interests></hobbies_and_interests>
        <affiliations></affiliations>
        <college_list list="true">
            <college>
                <name><![CDATA[University of California - Davis]]></name>
                <region>California</region>
                <country>United States</country>
                <city></city>
                <year_start>2000</year_start>
                <year_end>2003</year_end>
                <major><![CDATA[Communications]]></major>
                <degree>127</degree>
                <course></course>
                <class_of>2002</class_of>
            </college>
        </college_list>
        <school_list list="true">
            <school>
                <name><![CDATA[Joplin High]]></name>
                <region>Missouri</region>
                <country>United States</country>
                <city>Joplin</city>
                <year_start>2000</year_start>
                <year_end>2004</year_end>
                <major></major>
                <degree>0</degree>
                <course></course>
                <class_of>2004</class_of>
            </school>
        </school_list>
        <school_other></school_other>
        <favorites>
            <books><![CDATA[Confessions of a Shopaholic]]></books>
            <movies><![CDATA[Ferris Bueller's Day Off, Friday, Goonies, Zoolander, 50 First Dates, Elf]]></movies>
            <music><![CDATA[all kinds...it just depends on the mood]]></music>
            <tv_shows><![CDATA[24 BABY!!!!!  SNL, Conan O'Brien, Friends, Reality TV...esp. American Idol,
 CSI, Nip Tuck, Chappelle's Show]]></tv_shows>
        </favorites>
        <about_me><![CDATA[I'm John Doe]]></about_me>
        <want_to_meet><![CDATA[Anyone who wants to be my friend]]></want_to_meet>
        <birthday>
            <year>1984</year>
            <month>07</month>
            <day>25</day>
        </birthday>
    </user>
</user_response>

Example Error Response :

<error_response xmlns="<http://api.friendster.com/v1/>"
    xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>"
xsi:schemaLocation="http://api.friendster.com/v1/
http://api.friendster.com/v1/friendster.xsd">
<error_code>7</error_code>
<error_msg>Unauthorized source IP address (ip was: 10.1.2.3)</error_msg>
</error_response>

Get Friends List

Resource URL : http://api.friendster.com/v1/friends/<UID>

Resource Methods : GET (Retrieval of friends list)

Resource Description : API to get the friends list of a user. If no user ID is specified, the friends list of the current logged in user will be returned.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/friends/57519?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012

Example Response (XML) :

<friends_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <friends list="true">
      <uid>57519</uid>
      <uid>12989</uid>
      <uid>57908</uid>
      <uid>48999</uid>
      <uid>37529</uid>
      <uid>97510</uid>
   </friends>
</friends_response>

Post Shoutout

Resource URL :http://api.friendster.com/v1/shoutout

Resource Method : POST (Updates the shoutout for the current user)

Resource Description : This API updates the shoutout of the current logged in user. If an empty value is passed as content, the current user shoutout will be cleared.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/shoutout
::Content-Type: multipart/form-data; boundary=xxx
MIME-version: 1.0

--xxx
Content-Disposition: form-data; name="content"

Traveling to Vegas!

Example Response (XML) :

<shoutout_response xmlns="http://api.friendster.com/v1/"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://api.friendster.com/v1/friendster.xsd">
    <status>updated</status>
</shoutout_response>

Example Error Response :

<error_response xmlns="<http://api.friendster.com/v1/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://api.friendster.com/v1/">
    <error_code>104</error_code>
    <error_msg>Invalid signature</error_msg>
</error_response>

Get Shoutout

Resource URL :http://api.friendster.com/v1/shoutout(/:user_id)

Resource Method : GET (Retrieves the shoutout of the current user if user_id is not specified. Otherwise, it gets the shoutout of the given user_id if present.)

Resource Description : This API gets the shoutout of the currently logged in user or the provided user_id if present.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/shoutout/1234

Example Response (XML) :

<shoutout_response xmlns="http://api.friendster.com/v1/"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://api.friendster.com/v1/friendster.xsd">
    <shoutouts>
      <uid>1234</uid>
      <shoutout>Hello world!</shoutout>
      <time>1317277054</time>
    </shoutouts>
</shoutout_response>

Example Error Response :

<error_response xmlns="<http://api.friendster.com/v1/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://api.friendster.com/v1/">
    <error_code>104</error_code>
    <error_msg>Invalid signature</error_msg>
</error_response>

Post Notification

Resource URL:

http://api.friendster.com/v1/notification
http://api.friendster.com/v1/notification/<uids>

Resource Method: POST (generate a notification)

Resource Description: API to generate a notification to the uids listed in the resource URL on behalf of the logged in user. If no uids are provided, the notification is generated for the logged in user. There is a limit to the number of notifications a user can receive per day from a single application. When a user receives an app notification, "NEW app notifications" displays in the notification panel in the logged in homepage. The notifications appear in the user's app notifications page as follows:

Request:

Response :

Error Conditions/Response :

Example Request:

    http://api.friendster.com/v1/notification/53642,72361,4734?type=1&
    api_key=2e37638f335f0545c3719d34f4d20ed0&content=hello%20world&
    subject=hello%20world%20app&label=click%20here&sig=fake_sig

Example Response (XML):

<?xml version="1.0" encoding="UTF-8"?>
<notifications_response
    xmlns="<%3Chttp://api.friendster.com/v1/>"xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>"
    xsi:schemaLocation="http://api.friendster.com/v1/ <http://api.friendster.com/v1/friendster.xsd>"
    list="true">
       <uid>53642</uids>
       <uid>72361</uids>
       <uid>4734</uids>
</notifications_response>

Example Error Response (XML):

<error_response xmlns="<http://api.friendster.com/v1/>"
    xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>"
    xsi:schemaLocation="http://api.friendster.com/v1/
    http://api.friendster.com/v1/friendster.xsd">
    <error_code>100</error_code>
    <error_msg>Missing parameters from notification</error_msg>
</error_response>

Get Application friends

Resource URL:

http://api.friendster.com/v1/application/friends

Resource Method:

GET (obtain list of friends who have the application currently installed)

Resource Description:

This API returns the list of friends who already installed a similar widget or application.

Request :

Response :

Error Conditions/Response :

Example Request:

http://api.friendster.com/v1/application/friends

Example Response (XML):

<application_friends_response xmlns="http://api.friendster.com/v1/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://api.friendster.com/v1/friendster.xsd" list="true">
    <application_friends>
      <uid>123456</uid>
      <uid>81213123</uid>
      <uid>12310993</uid>
    </application_friends>
</application_friends_response>

Example Error Response

<error_response xmlns="http://api.friendster.com/v1/"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://api.friendster.com/v1/">
<error_code>104</error_code>
<error_message>Invalid signature</error_message>
</error_response>

Get Conversation List

Resource URL : http://api.friendster.com/v1/messages;

Resource Methods : GET (Retrieval of user conversations)

Resource Description : API to get the conversations list of a user.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/messages?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012

Example Response (XML) :

<message_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <messages>
      <conversation>
        <cid>55</cid>
        <latest_message_body>Private message test reply</latest_message_body>
        <sender_id>445777</sender_id>
        <sender_name>secondOne</sender_name>
        <recipient_id>445758</recipient_id>
        <recipient_name>Jay</recipient_name>
      </conversation>
      <page>1</page>
      <next_page/>
   </messages>
</message_response>

Get Message List by Conversation ID

Resource URL : http://api.friendster.com/v1/message/:cid;

Resource Methods : GET (Retrieval of user messages by conversation id)

Resource Description : API to get the message list of a user by conversation id.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/message/120?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012

Example Response (XML) :

<message_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <messages>
      <message>
        <mid>120</cid∣
        <message_body>Private message test 2</message_body>
        <message_sender_id>445758</message_sender_id>
        <message_sender_name>Jay</message_sender_name>
        <message_recipient_id>445780</message_recipient_id>
        <message_recipient_name>Marc</message_recipient_name>
      </message>
      <page>1</page>
      <next_page/>
   </messages>
</message_response>

Post a message to an avatar

Resource URL : http://api.friendster.com/v1/messages;

Resource Methods : POST (Adding Message to a conversation)

Resource Description : API to post the message of a user.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/messages?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     recpient=9017&
     content=Hello+world&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012

Example Response (XML) :

<message_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <status>created</status>
</message_response>

Delete a Message from a Conversation

Resource URL : http://api.friendster.com/v1/messages/destroy/:mid;

Resource Methods : POST (Deleting a Message from a conversation)

Resource Description : API to delete the message of a user.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/messages/destroy/55?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012

Example Response (XML) :

<message_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <status>deleted</status>
</message_response>

Get the number of new messages

Resource URL: http://api.friendster.com/v1/newmessages

Methods: GET (query the number of new messages)

Resource Description: API to query the number of new messages for the current user since the last_update (optional parameter).

Request :

Response :

Error Conditions/Response:

Example Request:

http://api.friendster.com/v1/newmessages?
    api_key=2e37638f335f0545c3719d34f4d20ed0&
    nonce=326233766.3425&
    sig=012345678901234567890123456789012

Example Response (XML):

<newmessages_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/ http://api.friendster.com/v1/friendster.xsd">
     <new>5</new>
     <last_update>1112241241242424</last_update>
</newmessages_response>

Post Game Score

Resource URL : http://api.friendster.com/v1/score/:avatar_id

Resource Methods : POST (Adding game score)

Resource Description : API to post the game score of an avatar.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/score/11111?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012&
     score=100

Example Response (XML) :

<game_score_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <status>posted</status>
</game_score_response>

Get Top Score List

Resource URL : http://api.friendster.com/v1/score

Resource Methods : GET (Retrieval of top scores of the game)

Resource Description : API to get the list of top scores of the game.

Request :

Response :

Error Conditions/Response :

Example Request :

http://api.friendster.com/v1/score?
     api_key=2e37638f335f0545c3719d34f4d20ed0&
     session_key=M4yZuZ4LjoJQj5BJfTkw2HnGw6MG8JyM-57519&
     nonce=326233766.3425&
     sig=012345678901234567890123456789012

Example Response (XML) :

<game_score_response xmlns="http://api.friendster.com/v1/"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://api.friendster.com/v1/
     http://api.friendster.com/v1/friendster.xsd">
   <high_scores>
      <score>
        <avatar_id>445695</avatar_id>
        <score>100</score>
        <posted_at>1325127188</posted_at>
      </score>
   </high_scores>
</game_score_response>

BALANCE INQUIRY

Resource URL: https://api.friendster.com/v1/sessions/destroy

Resource Methods: POST (Destroy Session)

Resource Description: API to destroy the current session. The friendster system will issue a new session_key when the user tries to access your app/game again.

Request :

Response :

Error Conditions/Response :

Example Request :

 http://api.friendster.com/v1/sessions/destroy?
 api_key=2e37638f335f0545c3719d34f4d20ed0&session_key=M4yZuZ4LjoJQj5BJfT
 kw2HnGw6MG8JyM-57519&sig=fake_sig

Example Response (XML) :

<sessions_response xmlns="https://api.friendster.com/v1/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api.friendster.com/v1/ https://api.friendster.com/v1/friendster.xsd">
  <status>success</status>
</wallet_response>

Example Error Response :

<error_response xmlns="<https://api.friendster.com/v1/>"
xmlns:xsi="<http://www.w3.org/2001/XMLSchema-instance>"
xsi:schemaLocation="https://api.friendster.com/v1/
https://api.friendster.com/v1/friendster.xsd">
  <error_code>300</error_code>
</error_response>

Wallet API

The wallet APIs allow developers to access the wallet in order to facilitate the purchase of virtual goods and/or services within your game. The Wallet API is available to both premium and non-premium apps, however your app must have been upgraded to premium status in order to gain access to the real wallet otherwise your app will be limited to "sandbox" mode. Developers can use sandbox mode in order to prepare their app before they request for premium status.

The Friendster payment API flow

The Friendster payment API flow is designed so that the customer’s password is not passed to the application. It allows the user to approve all transactions to his or her wallet.

A purchase is performed using the following steps:

• App obtains a request token using the GET PAYMENT REQUEST (https:// {api_domain}/v1/wallet/payment) call. The app will need to supply all the purchase details including the amount, product name, description etc. The request token will be needed in the succeeding steps.
• The App will be required to redirect the user to the Payments Authentication page. The URL to the payments authentication page is returned in the response of the https:// {api_domain}/v1/wallet/payment call. The behavior of the payments authentication page is described in the "PAYMENTS AUTHENTICATION PAGE" section.
• The User must then enter his or her password in the Payments Authentication page. While the App has no control on the behavior of this page, it will however be redirected back to the app after the user has been successfully authenticated.
• After control is returned to the App via the redirect, assuming the authentication process is successful the next step is for the App to issue the COMMIT PAYMENT REQUEST (https:// {api_domain}/v1/wallet/commit). At this point, the balance of the user is deducted and the App may now deliver the product purchased by the user. The transaction commit is successful if and only if there is a successful response and a transaction id is returned. For accounting purposes the App is advised to store the corresponding transaction id returned by this call. Please note that for non-sandbox mode, there will be a corresponding entry in the users’ wallet transaction history.

How the Sandbox environment works

The Wallet API provides a sandbox environment where the application developer can use a fake wallet and coins balance in order to perform integration testing. Each application has its own sandbox, which means that two different applications will transact against distinct wallets. If an application developer manages two applications, the application developer will have separate balances for each sandbox. Also, a distinctive chrome is displayed around your app's iframe indicating sandbox mode.

For premium apps you can access sandbox mode by clicking on the “play in sandbox” link (non-premium or normal apps will always use the sandbox wallet). A flag “sandbox=true” will be passed to your app via the iframe if the current session is using sandbox mode. The app should use this flag to prevent confusion during billing, as transactions performed against sandbox mode is not valid. Sandbox mode is only accessible by the developer and admin. The sandbox and production wallets are distinct. When an application is not played in sandbox mode, it will access the wallet the current user has created.

The sandbox wallet is automatically created upon the first use of the application in its sandbox environment. The initial balance for each new sandbox wallet is 1000000 coins.