Find Answers/Publishers/Developer Documentation

XML (v2)/JSON VIDEO API

Jehan Zeb
posted this on September 02, 2012 05:36 AM


XML (v2)/JSON VIDEO API Documentation

1. Prerequisites:

Before you can make an XML request, please make sure the following tasks have been completed:

  1. Create a SuperRewards Publisher account on www.superrewards.com. If you already have one, skip this step.
  2. Log in and create a new application for your account.
    (NOTE: if the application you will be adding the offerwall to already exists, you do not need to create a new one)
  3. Locate your unique app identifier (h) as outlined below.

Unique App Identifier:

The unique app identifier (h) is the encrypted string that identifies the app that is making the XML request. This identifier is created when you sign up for a SuperRewards Publisher account and create an app; if you have an app already, the unique app identifier (h) has already been created for you.

The unique app identifier (h) is needed to load the XML as it identifies the app that is making the request. To find your unique app identifier (h), you need to log in to your SuperRewards Publisher account and edit the application that you wish to place the Flash Offerwall on by clicking on the "edit" link located next to that specific application. On the "Edit Application" page, you will see a box that appears like Figure 1a below. Your unique app identifier is the h parameter located in the query string of the iframe (highlighted in bold red font).

<iframe src="https://www.superrewards-offers.com/super/offers?h=xxxxx.xxxxxxxxxxx&uid=[USER ID]" frameborder="0" width="728" height="2400" scrolling="no"></iframe>
Figure 1a: Locating your unique publisher identifier.

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.

https://www.superrewards-offers.com/super/offers?h=xxxxxx.xxxxxxxxxxxx&uid=xxxxxx&ip=xxx.xxx.xxx.xxx&xml=1&v=2&hdpay=1&mode=video
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.
mode: Must be set to video. Will return only video offers.

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.

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>10001</id>
- <name>SuperRewards Video campaign</name>
- <description>Video campaign discription here. Watch and Earn!</description>
- <requirements>Points are awarded after complete video view.</requirements>
- <payout>3</payout>
- <type>video</type>
- <offer_type>offer</offer_type>
- </offer>
- <offer>
...
- </offer>
- <offers>
Figure 3a: Example XML response.

4. Definitions:

"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: video, 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).

5. JSON API:

The JSON option allows you to build a custom presentation for the offers page just like the XML API. Only difference instead of specifying XML in the URL you specify JSON instead. The format is similar to that of the XML. Look at the XML documentation to understand the fields. Please notice that the url is the same as your applications iframe url with the ip ,json, & mode parameters appended to the end of the url. Look at figure 4a.

https://www.superrewards-offers.com/super/offers?h=xxxxxx.xxxxxxxxxxxx&uid=xxxxxx&ip=xxx.xxx.xxx.xxx&json=1&mode=video
Figure 4a: Example JSON query call for the JSON offer feed.

6. Additional Help:

For more help regarding the XML Video API (v2) or the JSON api setup, please contact your Account Manager.

 
Topic is closed for comments