Initialization
Integrating TyrAds web is easy and can be done by just passing the url in the in-app-browser or iframe:
https://websdk.tyrads.com/?apiKey=YOUR_API_KEY&apiSecret=YOUR_API_SECRET&userID=CUSTOMER_USER_ID&platform=web
Just replace the following values with your own.
YOUR_API_KEY
YOUR_API_SECRET
CUSTOMER_USER_ID
Deeplinking Routes
The Tyrads SDK supports deeplinking to specific sections of the offerwall. When initializing or interacting with the SDK, you can specify a route to open a particular page. For campaign-specific routes, you'll need to provide the campaignID as well.
Available routes and their usage:
campaigns
- opens the Campaigns Pagecampaigns-activated
- opens the Activated Campaigns Pagecampaign-details
- opens the Campaign Details Page (requires campaignID)campaign-tickets
- opens the Campaign Tickets Page (requires campaignID)
// Note: CAMPAIGNS is the default route when no specific route is provided
https://websdk.tyrads.com/?apiKey=YOUR_API_KEY&apiSecret=YOUR_API_SECRET&userID=CUSTOMER_USER_ID&platform=web
// Explicitly specifying the Campaigns Page by appending `&route=campaigns` to the URL
https://websdk.tyrads.com/?apiKey=YOUR_API_KEY&apiSecret=YOUR_API_SECRET&userID=CUSTOMER_USER_ID&platform=web&route=campaigns
// Activated Campaigns Page by appending `&route=campaigns-activated` to the URL
https://websdk.tyrads.com/?apiKey=YOUR_API_KEY&apiSecret=YOUR_API_SECRET&userID=CUSTOMER_USER_ID&platform=web&route=campaigns-activated
// Campaign Details Page (requires campaignID) by appending `&route=campaign-details&campaignID=YOUR_CAMPAIGN_ID` to the URL
https://websdk.tyrads.com/?apiKey=YOUR_API_KEY&apiSecret=YOUR_API_SECRET&userID=CUSTOMER_USER_ID&platform=web&route=campaign-details&campaignID=YOUR_CAMPAIGN_ID
// Campaign Tickets Page (requires campaignID) by appending `&route=campaign-tickets&campaignID=YOUR_CAMPAIGN_ID` to the URL
https://websdk.tyrads.com/?apiKey=YOUR_API_KEY&apiSecret=YOUR_API_SECRET&userID=CUSTOMER_USER_ID&platform=web&route=campaign-tickets&campaignID=YOUR_CAMPAIGN_ID
If your website is using html, you can use the following steps to integrate TyrAds web:
add an iframe to your page
<iframe id="tyrads_iframe" src="" height="650" width="300"></iframe>
provide the source URL dynamically to the iframe src attribute
<script type="text/javascript" deffered>
(function () {
var frameElement = document.getElementById("tyrads_iframe");
var apiKey = "YOUR API KEY"
var apiSecret = "YOUR API SECRET"
var userId = "1234567890"
frameElement.src = "https://websdk.tyrads.com/?apiKey=" + apiKey + "&apiSecret=" + apiSecret + "&userID=" + userId + "&platform=web";
})();
</script>
Last updated