Bill Thompson
posted this on August 02, 2011 10:55 am
There are two elements of a Redemption campaign:
Redemption Code: the code that's required to redeem the file

Redeem Button: a button your fans must click to enter a code

This button is simply a piece of code, similar to the Offer buttons built in your Sell section. You can embed these anywhere and change their text or appearance as you would with an offer button. One important difference is that a Buy Button is unique to the products within that button, whereas a Redeem Button is generic, so you will use the same embed-code for every Redeem button, regardless of the media that's being redeemed. The Redeem Button determines which file to deliver based on the Redemption Code entered by the user.
There are two ways for your fans to access the Redeem Button:
1) Embed the Redeem Button on your website or other HTML page (the button below is a live Topspin redemption button; go ahead, test it! Click the button and enter "test" as the code word).
(you can also replace the default button above with an image URL of your own choosing).
2) Link to a variation of your generic Topspin Store page.

To access the default spinshop redemption URL seen above, click any redemption code in your Promote tab and go here:

Your default Spinshop Redemption URL will conform to this structure: http:// ARTIST_NAME.spinshop.com/store/redeem/ARTIST_NAME/ARTIST_ID
You can embed the generic Redeem widget code anywhere, with the same flexibility as you would apply to a Buy Button. Just copy and paste the Redeem Button code that appears below. Where you see "XXXX", insert your Artist ID Number to customize this code for your account (note that there are TWO places where XXXX appears):
<script type="text/javascript" src="http://cdn.topspin.net/javascripts/topspin_core.js
?aId=XXXX×tamp=1291316305"></script>
<a class="ts_buttonlink" href="javascript:void(0);"onclick="TSPF.RedeemButton.load
({aId:'XXXX', highlightColor: '#c9c9c9', theme:'black'});">REDEEM</a>
How To Generate Redemption Codes
There are two ways to generate Redemption Codes:
1) Create a Redemption Code Spin
2) Auto-generate Codes in an Email Blast

1) Go to Promote > New Offer > Redemption Code
4) Choose the product that will be delivered to the fan
5) Click the Publish button in the upper-right.
Once you Publish, you'll see the embed-code for the Redeem button. To generate codes immediately, click the "Edit this widget" link.
Now that you've created your codes, you'll probably want to download them so you can send them out to your fans. Here's how to download your codes in a spreadsheet:
1) Edit the Redemption Code campaign you just created. You should see a new field at the bottom called Redemption Codes with two buttons, "Generate Codes" and "Download Codes".
2) First, click "Generate Codes". A window will pop up asking you how many codes to generate. You may generate as many as you want, up to the limit you set in Quantity. The codes will appear in a table beneath the buttons. You can come back to this table to see which codes have been redeemed, and how many redemptions each code has incurred.
3) Next, click "Download Codes". This will download a spreadsheet (CSV file) that contains all your codes. 
For added convenience, you can generate unique Automatic codes from right within the email-blast creation tool. So for example, if you wanted to send an exclusive MP3 to a segment of your fan base, you could use this tool to create the code, associate it with the MP3, and insert it into the email blast all within the Email Creation window. Here are step-by-step instructions:
1) Start creating an email blast by going to Promote > Email.
2) Check the "Include Redemption Code" box and click "Configure".


3) Enter a Name for the Redemption Code. This process will create a Redemption Code in the Promote section where you can edit the code's rules and view redemptions.
4) Set the amount of Redemptions Per Code that you want to allow.
5) Choose the product that will be delivered upon redemption of the code.
6) Once you click OK, continue writing the email as usual. When you want to insert the code into the email, just add the following text: REDEMPTION_CODE
For example, you might write "To redeem your free MP3, just enter the following code: REDEMPTION_CODE ." When recipients read the email, they will see a unique code in place of the "REDEMPTION_CODE" text. This function automatically creates one unique code for every email address you send the email to.
IMPORTANT NOTE: Make sure your email includes a link to a webpage with the Redeem Button, so your fans have somewhere to go to redeem their code. For help on creating a Redeem Button, see instructions above.

See below for technical notes relating to the Redemption process.
The redemption code widget appears as embeddable code after publishing your redemption code widget for fans to easily redeem their vanity or automatic codes.
Although you'll receive embed code each time you create new redemption codes (vanity or automatic), the same redemption code widget applies for all your codes. You do not need to create embed a new widget each for each new code you generate.
The redemption widget code can be embedded anywhere you choose or we have provided a default widget off of your public offers page. This can be accessed by editing any of your redemption code spin details section.

Once embedded, the redemption code widget is a simple text entry field with a submit. After validating the code, a topspin url is provided with a download of your assets.

|
Parameter
|
Default Value
|
Description
|
| theme | black | general theme for the colors of the UI. The theme can be overridden by passing the following flashvars for the colors. Can be "black" or "white". |
| highlightColor | 0x00A1FF | Dictates the color of the textfield border and button color. |
| bgColor | 0x000000 | Color of the background surrounding the button and textfield |
| bgAlpha | 0 | Values can be 0-1, background alpha |
| errColor | 0xff0000 | Color of the textfield border when an error occurs |
| fontColor | 0xffffff | Color of the text inside the button on Rollover. |
By default the widget has a transparent background and is controlled by the bgAlpha=0 setting in the flashVars embed code, to make the background opaque, change the value to bgAlpha=1. Once the widget is published, you can also change the width of the widget by updating the width parameter in the embed code.
PLEASE NOTE: There is only one actual redemption widget_id for any artist. This means that you can create different spins with different redemption codes, but the embed code for the widget will always be the same. This allows you to be able to put a single embed code redemption widget on your homepage, and create as many spins you desire, the embed will be unchanged and work for all case.
The Flash swf redemption widget is deprecated and now the application will give you an embed code for a button which will launch a Redemption window in a lightbox. You may still use the flash version, but it will not work for Redeeming Access Products. It should be used for Download links only
<object type="application/x-shockwave-flash" height="27" width="300" id="TSWidget26492" data="http://cdn.topspin.net/widgets/redeem/TSRedemptionWidget.swf?timestamp=1276802137" bgColor="#000000"> <param value="always" name="allowScriptAccess" /> <param name="allowfullscreen" value="true" /> <param name="quality" value="high" /> <param name="wmode" value="transparent" /> <param name="movie" value="http://cdn.topspin.net/widgets/redeem/TSRedemptionWidget.swf?timestamp=1276802137" /> <param name="flashvars" value="widget_id=http://app.topspin.net/api/v1/offers/redeem/817/&theme=black&bgAlpha=0" /> </object>
To modify this embed code for the flash redemption widget, just change the artist_id to yours. (817 in the example above) (e.g widget_id=http://app.topspin.net/api/v1/offers/redeem/<artist_id>
You can directly create the api url for custom implementation:
http://app.topspin.net/api/v1/offers/redeem/<artist-id>/<redemption-code>
Successful Redemption:
{ "status": "ok", "download_url": "t.opsp.in/IDsN" }
Unsuccessful Redemption:
{ "status": "error", "message": "some descriptive text"}
The source code for the flash widget can be found on GitHub:
http://github.com/amehta3000/topspin-flash-widget-api![]()
You will need the TSAPI in your classpath, and the source of the Redemption widget is found here:
http://github.com/amehta3000/topspin-flash-widget-api/tree/master/TSWidgets/src/![]()
Comments
How do you set up a request for an email address in exchange for the free download (Redemption)?
I would also like to know how to set up a redemption code exchange for email address.
Hi guys - at the moment, Email for Media widgets and Redemption Codes are separate promotional tools. However, if you'd like to send a free redemption code to every user acquired by a particular Email for Media widget, simply go to your Promote tab, compose an email and address it to Smart Group > Acquired By Offer > Email for Media > ...
Then, click "Include Redemption Code"
After configuring your redemption code, all you need to do is include "REDEMPTION_CODE" in your email body to generate randomized codes for all recipients!
Hi gang: Is it possible to use a redemption code to use on the shopping cart? i.e, we want to distribute a limited-time code to get an item in our store for free, but we want them to go through the checkout process so we can capture their e-mail address, etc., at which time the price will reduce from (say) $5.99 to $0.00. Thanks!
Hi Trond, while Topspin does not currently have a "discount code" feature, we appreciate the feature request!