# NodeJS

Integrate your NodeJS app with us using our NodeJS package

## Installation

Add `@tyrads.com/tyrads-sdk-iframe` to your `package.json` as follows:

```
npm install --save @tyrads.com/tyrads-sdk-iframe
# or
yarn add @tyrads.com/tyrads-sdk-iframe
```

> The latest available version of NodeJS  `@tyrads.com/tyrads-sdk-iframe`  is [v0.2.2](https://github.com/tyrads-com/tyrads-node-sdk-iframe/releases/tag/v0.2.2).

## Get Started

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

```php
const tyradsSDK = TyradsSDK.make(API_KEY, API_SECRET);
```

### Localization

This `TyrAdsSdk` class also supports localization, more info about [localization](https://sdk-doc.tyrads.com/iframe/manual-integration#localization)

For example:

```php
const tyradsSDK = TyradsSDK.make(API_KEY, API_SECRET, "en");
```

## Authentication

You can do the authentication by calling to our package

```php
const authResponse = await tyradsSDK.authenticate({
    "PUBLISHER_USER_ID", // Publisher User
});
```

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

```php
const iframeUrl = tyradsSDK.iframeUrl(authResponse.getToken())
// Result: https://sdk.tyrads.com?token=eyJ2YWwiOiI3M3NIeUpNQlp4QzA1TlRHVzhxRExhWWNTeUQ5TTJIT0h3NXBvL3djVVp1Z09MR20wOTJJOTRReDBuYUFLeXhmVGRCaGYra2gvVGcydWFlbUh6aWR6S00vTmV0SEtVZVlWNk5Pdkc5Wnd5bytkSkxmUnA0aWt2eE9yQ01YTXF6LzBnRmZ3RUpucHMxem95WnRkYkVlQXJQNER3cDRZVkttb1lBdEIrZlB6cFZ3R25SSEE5UjROa2U2cGJTeTJod2c2UmI3UnN0QzZiN2Y2cENBYTlqaEhvQXhtdjM5UERPU2tDdWpHMmJIQ2N1cVRldVQ4a3hDSEE9PSIsInZlYyI6InNWbzZrejZRa09iS0tDeDUiLCJ0YWciOiJ1eDNnbjEwNEdUWXpvV1J2TTZVck1BPT0ifQ==
```

{% hint style="info" %}

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
   {% endhint %}

### Deeplinking Routes

This `iframeUrl` method also supports deeplinking, more info about [deeplinking routes](https://sdk-doc.tyrads.com/iframe/manual-integration#deeplinking-routes)

For example:

```php
const iframeUrl = tyradsSDK.iframeUrl(authResponse.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:

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

For example:

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

## Example

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

{% embed url="<https://github.com/tyrads-com/nodejs-sdk-iframe-example/blob/main/TyrAdsSdk/index.js>" %}