Your users can
view the status of their offer completions by clicking on a link from the offer
page that takes them to a Tapjoy I‐Frame. The account status API call will
allow you to provide this to your users by leveraging the Tapjoy JSON/XML API
feed. The API for account status allows you to customize the layout of the user
status page. To request the account status for a user, you should use the
following format:
http://pub.myofferpal.com/[APPLICATION_ID]/userstatusAPI.action?snuid=[SNUID]&callbackFormat=[CALLBACKFORMAT]
The
parameters for the JSON/XML User Status API are explained in the table below:
|
Key
|
Description
|
Required/ Optional
|
|
APPLICATION_ID
|
Unique identifier provided
in the Tapjoy URL.
What is my application id?
|
Required
|
|
snuid
|
Social Network User ID
What is a SNUID?
|
Required
|
|
Callback Format
|
The return format of the
result, Possible values:”json”,”xml”. Defaultvalue is “json”
|
optional |
Example API call to request account status:
http://pub.myofferpal.com/98765/userstatusAPI.action?snuid=12345&callbackFormat=json
When a JSON/XML Account Status API call is made, Tapjoy will respond with the following set of data:
|
Key
|
Description
|
Format
|
|
id
|
Id for transaction
|
Text string
|
|
timeDelay
|
Delayed Processing time
|
Text string
|
|
offerDescription
|
Description of offer
|
Text string
|
|
Created
|
Offer creation time
|
Timestamp sample: 2009‐06‐08
09:52:35.0
|
|
Status
|
Offer status
|
Text string
|
|
canSubmitCSRequest
|
Decide if the user can send emto
the customer service yet
|
boolean
|
|
offerInstructions
|
Instructions for payment
|
Text string
|
|
offerName
|
Name of the offer
|
Text string
|
|
dropName
|
Name of the application
|
Text string
|
|
offerId
|
Id for offer
|
Text string
|
JSON Sample
{"customerServiceEmail":"crego@myofferpal.com",
"offerStatus":
[{
"id":"45247",
"timeDelay":"within minutes",
"offerDescription":"The simple and trusted
way to pay.",
"created":"2009-06-15 16:00:53.0",
"status":"initiated",
"canSubmitCSRequest":"true",
"offerInstructions":"<ul><li>Use
your Amazon account to pay.<\/li> <\/ul>",
"offerName":"Amazon - Amazon Payments",
"dropName":"Claim Your Prize",
"offerId":"e201aa6b1e18074e011e22a018470216"
}]
}
XML Sample
<userStatus>
<customerServiceEmail>crego@myofferpal.com</customerServiceEmail>
<statusList>
<statusMember>
<status>initiated</status>
<offerInstructions><ul><li>Use
your Amazon account to pay.<\/li>
<\/ul></offerInstructions>
<id>45247</id>
<timeDelay>within
minutes</timeDelay>
<created>2009-06-01
10:00:42.0</created>
<offerDescription>The
simple and trusted way to
pay.</offerDescription>
<canSubmitCSRequest>true</canSubmitCSRequest>
<dropName>Claim
Your Prize</dropName>
<offerName>Amazon
- Amazon Payments</offerName><offerId>e201aa6b1e18074e011e22a018470216</offerId
</statusMember>
</statusList>
</userStatus>
