2. Querying For XML:
The XML option allows you to build a custom presentation for the offers page within your application.
Please notice that the url is the same as your applications iframe url with the ip, xml, and v parameters
appended to the end of the url.
To query for the XML offer feed, simply copy and paste the code shown below in Figure 2a.
http://www.superrewards-offers.com/super/offers?h=xxxxxx.xxxxxxxxxxxx&uid=xxxxxx&ip=xxx.xxx.xxx.xxx&xml=1&v=3
Figure 2a: Example XML query call for the XML offer feed.
Required parameters:
• h: The unique app identifier (h) that you located above.
• uid: The unique user id. It is important not to cache the XML feed to use it for multiple users as the offers
returned for each uid are different and optimized for each uid.
• ip: The ip address of the user (used for location-based filtering of offers). It is critical that the offers shown to each user are filtered to only show those
offers available to their country or location.
• xml: Must be set to 1. Turns the normal offers page into an XML response.
• v: Must be set to 3. Returns version 3 of the XML offer feed.
Optional parameters:
• hdpay: If set to 1, direct payment options will be hidden.
• hoffers: If set to 1, offers will be hidden.
• n_offers: Specifies how many offers to return per page (defaults to 30).
• mode: Specifies the types of offers that are returned (defaults to "all"). Possible
values are "all", "free", "paid" or "mobile".
3. XML Format:
IMPORTANT NOTE: Super Rewards strongly recommends that you present the offers to your users in the order in which they
are returned in the XML feed. Super Rewards runs optimizations on the offers presented. The offers are not only optimized
for your specific application, but for each individual too.
Also note that the "direct-pay" style offers (such as credit cards or PayPal) will always be presented first. When forwarding a user, direct-pay offers are required to pass an "amount" value.
This typically involves displaying the price points in some form of drop-down or selection list. So we suggest that the "direct-pay" offers be presented differently or separate from the standard offers.
Below in Figure 3a is a sample XML response.
- <offers currency="points" n_pages="1" problems_page="http://apps.facebook.com/superrewards_status/">
- <offer>
<id>1000</id>
<name>Credit Card</name>
<description>Charge with your credit card</description>
<requirements />
<payout>0</payout>
<type />
<url>http://super.kitnmedia.com/super/dpay?h=fnbnznsllynxmhnfierz.151742694587</url>
<offer_type>direct</offer_type>
<icon>http://cdn.superrewards-offers.com/img/directpay/vendors/creditcard.png</icon>
<icon_large>http://cdn.superrewards-offers.com/img/directpay/large/creditcards_logo_horiz.png</icon_large>
<short_name>socialgoldcc</short_name>
<short_description>Credit Card</short_description>
<long_description>Pay directly using your credit card.</long_description>
- <price_points>
<price amount="5" text="50 points for $5.00" />
<price amount="10" text="100 points for $10.00" />
<price amount="20" text="200 points for $20.00" />
</price_points>
- <method_types>
<type>creditcard</type>
</method_types>
</offer>
- <offer>
<id>1001</id>
<name>SuperReward Buddies - Add Application of the Day</name>
<description>SuperRewards Buddies description is available here. This description lets the user know what the offer is presenting.</description>
<requirements>Must install the app to receive points. New users only.</requirements>
<payout>3</payout>
<type>free</type>
<url>http://super.kitnmedia.com/super/go?h=gymcylxtzijlkyknfziyfdmfrmnxrdeekchfdpigkhqhrxiqsmzxy.10695967214&r=&sl=1</url>
<offer_type>offer</offer_type>
<icon>http://cdn.superrewards-offers.com/img/free.gif</icon>
</offer>
Figure 3a: Example XML response.
"offers" (root tag attributes)
• currency: The name of your application's currency.
• n_pages: The number of pages of offers available.
• problems_page: The URL that must be presented to your users in case they need to reach
the Super Rewards customer support representatives in cases where users have problems receiving points.
"offer" - offer_type: direct
• id: A unique ID for the offer.
• name: The name of the offer.
• description: A description of the offer so the user has a better understanding of what the offer is.
• requirements: The requirements describe the steps the user must take on the offer to be awarded their points on your application.
It is important that the user has a clear understanding of the offer's expectations.
• payout: The number of points the user will receive if they complete the offer. Offers that have a payout of 0 have variable outputs
that depend on how much the user wishes to pay.
• type: One of the following types: free, paid or mobile.
• url: The URL to send the user to when the offer is clicked.
• offer_type: One of the following offer types: direct or offer. Used to distinguish between offers available for direct pay options and offers
to be presented in the offerwall.
• icon: An icon for the direct pay option.
• icon_large: A larger icon for the direct pay option.
• short_name: An abbreviated format of the direct pay option.
• short_description: The short description that displays quickly to the user what the direct pay option is. Example: Credit Card * Paypal.
• long_description: A description that provides the user with more information regarding the direct pay option.
It is strongly recommended that this option
be presented to the user to provide them with a clear understanding of the offer.
• price_points: The available amounts to be presented to the user for the direct pay option. Each price point has an amount, a text and a points attribute.
The text attribute is a localized string that can be displayed to the user.
The amount attribute is an amount value that must be appended to the URL when forwarding the user.
The local_amount attribute is a localized price. Only exists when we can bill directly in that currency [OPTIONAL].
The currency attribute is a local currency. Only exists when we can bill directly in that currency [OPTIONAL].
The points attribute is the amount of virtual currency the user will receive.
IMPORTANT: The amount needs to be appended to the url for the direct pay option
when the option is clicked.
Using the sample code above, in order to forward a user to PayPal for a $5 transaction, you would need to send a user to
http://super.kitnmedia.com/super/dpay?h=fnbnznsllynxmhnfierz.151742694587&amount=5
• method_types: The method types are a list of the general types of transactions supported by this provider. One provider can support multiple types.
Possible types: creditcard, paypal, bank, phone, prepaid, cash, other, etc.
When creating a User Interface, these are generally used for grouping similar direct pay options together.
"offer" - offer_type: offer
• id: A unique ID for the offer.
• name: The name of the offer.
• description: A description of the offer so the user has a better understanding of what the offer is.
• requirements: The requirements describe the steps the user must take on the offer to be awarded their points on your application.
It is important that the user has a clear understanding of the offer's expectations.
• payout: The number of points the user will receive if they complete the offer. Offers that have a payout of 0 have variable outputs
that depend on how much the user wishes to pay.
• type: One of the following types: free, paid or mobile.
• url: The URL to send the user to when the offer is clicked.
• offer_type: One of the following offer types: direct or offer. Used to distinguish between offers available for direct pay options and offers
to be presented in the offerwall.
• icon: An optional icon to be displayed beside the offer (free or purchase images).
XML API (v3)