PHP

Integrate your PHP app with us using our PHP package

This library supports PHP 5.5+

Installation

Add tyrads/tyrads-sdk to your composer.json as follows:

composer require tyrads/tyrads-sdk

The latest available version of PHP tyrads/tyrads-sdk is v0.4.1.

Get Started

After successfully installing our package, create a TyrAdsSdk object with your API key and API secret:

use Tyrads\TyradsSdk\TyrAdsSdk;

$tyrAdsSdk = TyrAdsSdk::make("API_KEY", "API_SECRET");

Localization

This TyrAdsSdk class also supports localization, more info about localization

For example:

$tyrAdsSdk = TyrAdsSdk::make("API_KEY", "API_SECRET", "en");

Authentication

You can do the authentication by calling to our package

$authRequest = new AuthenticationRequest(
    "PUBLISHER_USER_ID", // Publisher User
);
$authSign = $tyrAdsSdk->authenticate(
    $authRequest
);

After obtaining the token successfully, you can call iframeUrl method to get the iframe URL

$url = $tyrAdsSdk->iframeUrl($authSign->getToken());
// Result: https://sdk.tyrads.com?token=eyJ2YWwiOiI3M3NIeUpNQlp4QzA1TlRHVzhxRExhWWNTeUQ5TTJIT0h3NXBvL3djVVp1Z09MR20wOTJJOTRReDBuYUFLeXhmVGRCaGYra2gvVGcydWFlbUh6aWR6S00vTmV0SEtVZVlWNk5Pdkc5Wnd5bytkSkxmUnA0aWt2eE9yQ01YTXF6LzBnRmZ3RUpucHMxem95WnRkYkVlQXJQNER3cDRZVkttb1lBdEIrZlB6cFZ3R25SSEE5UjROa2U2cGJTeTJod2c2UmI3UnN0QzZiN2Y2cENBYTlqaEhvQXhtdjM5UERPU2tDdWpHMmJIQ2N1cVRldVQ4a3hDSEE9PSIsInZlYyI6InNWbzZrejZRa09iS0tDeDUiLCJ0YWciOiJ1eDNnbjEwNEdUWXpvV1J2TTZVck1BPT0ifQ==

1. A new token must be requested each time a user wants to access the offerwall.

2. Each token is valid for 7 days only

Deeplinking Routes

This iframeUrl method also supports deeplinking, more info about deeplinking routes

For example:

$url = $tyrAdsSdk->iframeUrl($authSign->getToken(), "/settings/language");
// Result: https://sdk.tyrads.com?to=/settings/language&token=eyJ2YWwiOiI3M3NIeUpNQlp4QzA1TlRHVzhxRExhWWNTeUQ5TTJIT0h3NXBvL3djVVp1Z09MR20wOTJJOTRReDBuYUFLeXhmVGRCaGYra2gvVGcydWFlbUh6aWR6S00vTmV0SEtVZVlWNk5Pdkc5Wnd5bytkSkxmUnA0aWt2eE9yQ01YTXF6LzBnRmZ3RUpucHMxem95WnRkYkVlQXJQNER3cDRZVkttb1lBdEIrZlB6cFZ3R25SSEE5UjROa2U2cGJTeTJod2c2UmI3UnN0QzZiN2Y2cENBYTlqaEhvQXhtdjM5UERPU2tDdWpHMmJIQ2N1cVRldVQ4a3hDSEE9PSIsInZlYyI6InNWbzZrejZRa09iS0tDeDUiLCJ0YWciOiJ1eDNnbjEwNEdUWXpvV1J2TTZVck1BPT0ifQ==

Embedding The Iframe

If your website is using html, you can add an iframe to your page to integrate TyrAds web:

<iframe id="tyrads_iframe" src="[IFRAME_LINK]" height="650" width="300"></iframe>

For example:

<iframe id="tyrads_iframe" src="https://sdk.tyrads.com?token=eyJ2YWwiOiI3M3NIeUpNQlp4QzA1TlRHVzhxRExhWWNTeUQ5TTJIT0h3NXBvL3djVVp1Z09MR20wOTJJOTRReDBuYUFLeXhmVGRCaGYra2gvVGcydWFlbUh6aWR6S00vTmV0SEtVZVlWNk5Pdkc5Wnd5bytkSkxmUnA0aWt2eE9yQ01YTXF6LzBnRmZ3RUpucHMxem95WnRkYkVlQXJQNER3cDRZVkttb1lBdEIrZlB6cFZ3R25SSEE5UjROa2U2cGJTeTJod2c2UmI3UnN0QzZiN2Y2cENBYTlqaEhvQXhtdjM5UERPU2tDdWpHMmJIQ2N1cVRldVQ4a3hDSEE9PSIsInZlYyI6InNWbzZrejZRa09iS0tDeDUiLCJ0YWciOiJ1eDNnbjEwNEdUWXpvV1J2TTZVck1BPT0ifQ==" height="650" width="300"></iframe>

Example

For example implementation using our PHP SDK, you can find it here

php-sdk-iframe-example/TyrAdsSdk/src/index.php at main · tyrads-com/php-sdk-iframe-exampleGitHub