Manual Integration

If your platform is not supported, you can integrate with us manually by making HTTP requests to our API using any HTTP client.

Authentication

You can make a request to our API using any HTTP client by following the API documentation below

Initialize SDK Session

post

Query parameters

langstringOptionalExample: en

Header parameters

X-Api-KeystringRequiredExample: YOUR_API_KEY

X-Api-SecretstringRequiredExample: YOUR_API_SECRET

X-SDK-PlatformstringRequiredExample: Web

X-SDK-VersionstringRequiredExample: 3.0

Body

agenumberRequired

User age

Example: 20

gendernumberRequired

User gender, 1=male, 2=female

Example: 1

publisherUserIdstringRequired

Publisher User/Customer unique ID

Example: user_id_1

emailstring | nullableOptional

User email

Example: [email protected]

phoneNumberstring | nullableOptional

User phone

Example: 6281234567890

sub1string | nullableOptional

sub2string | nullableOptional

sub3string | nullableOptional

sub4string | nullableOptional

sub5string | nullableOptional

userGroupstring | nullableOptional

mediaSourceNamestring | nullableOptional

mediaSourceIdstring | nullableOptional

mediaSubSourceIdstring | nullableOptional

incentivizedboolean | nullableOptional

mediaAdsetNamestring | nullableOptional

mediaAdsetIdstring | nullableOptional

mediaCreativeNamestring | nullableOptional

mediaCreativeIdstring | nullableOptional

mediaCampaignNamestring | nullableOptional

Responses

200

Successful operation

application/json

403

Unsuccessful operation

application/json

422

Unsuccessful operation

application/json

429

Unsuccessful operation

application/json

post

HTTPcURLJavaScriptPython

POST /v3.0/auth HTTP/1.1
Host: api.tyrads.com
X-Api-Key: text
X-Api-Secret: text
X-SDK-Platform: text
X-SDK-Version: text
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "age": 20,
  "gender": 1,
  "publisherUserId": "user_id_1",
  "email": "[email protected]",
  "phoneNumber": 6281234567890,
  "sub1": "text",
  "sub2": "text",
  "sub3": "text",
  "sub4": "text",
  "sub5": "text",
  "userGroup": "text",
  "mediaSourceName": "text",
  "mediaSourceId": "text",
  "mediaSubSourceId": "text",
  "incentivized": true,
  "mediaAdsetName": "text",
  "mediaAdsetId": "text",
  "mediaCreativeName": "text",
  "mediaCreativeId": "text",
  "mediaCampaignName": "text"
}

{
  "data": {
    "token": "eyJ2YWwiOiI3M3NIeUpNQlp4QzA1TlRHVzhxRExhWWNTeUQ5TTJIT0h3NXBvL3djVVp1Z09MR20wOTJJOTRReDBuYUFLeXhmVGRCaGYra2gvVGcydWFlbUh6aWR6S00vTmV0SEtVZVlWNk5Pdkc5Wnd5bytkSkxmUnA0aWt2eE9yQ01YTXF6LzBnRmZ3RUpucHMxem95WnRkYkVlQXJQNER3cDRZVkttb1lBdEIrZlB6cFZ3R25SSEE5UjROa2U2cGJTeTJod2c2UmI3UnN0QzZiN2Y2cENBYTlqaEhvQXhtdjM5UERPU2tDdWpHMmJIQ2N1cVRldVQ4a3hDSEE9PSIsInZlYyI6InNWbzZrejZRa09iS0tDeDUiLCJ0YWciOiJ1eDNnbjEwNEdUWXpvV1J2TTZVck1BPT0ifQ=="
  },
  "message": "OK"
}

After obtaining the token successfully, you can pass the token to our iframe link and embed the iframe on your page.

https://sdk.tyrads.com?token=[TOKEN_HERE]

For example:

https://sdk.tyrads.com?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>

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.

Supported Routes

• /offers - open the offerwall page (default)

• /active-offers - open the active offers page

• /active-offers?groupName=[groupId]&campaignId=[campaignId] - open active offers page on specific tab group and campaign, replace the [campaignId] with the ID of the campaign and groupId with the ID of the group

• /offers/[campaignId] - open the offer detail page, replace the [campaignId] with the ID of the campaign

• /support/[campaignId] - open the offer support page, replace the [campaignId] with the ID of the campaign

• /support/[campaignId]/not-receive-points - open the offer support ticket page, replace the [campaignId] with the ID of the campaign

• /settings - open the settings page

• /settings/language - open the language settings page

Usage Examples

You can pass the deeplink route into the to URL parameter as following

https://sdk.tyrads.com?token=[TOKEN_HERE]&to=[DEEPLINK_ROUTE]

For example:

https://sdk.tyrads.com?to=/settings/language&token=eyJ2YWwiOiI3M3NIeUpNQlp4QzA1TlRHVzhxRExhWWNTeUQ5TTJIT0h3NXBvL3djVVp1Z09MR20wOTJJOTRReDBuYUFLeXhmVGRCaGYra2gvVGcydWFlbUh6aWR6S00vTmV0SEtVZVlWNk5Pdkc5Wnd5bytkSkxmUnA0aWt2eE9yQ01YTXF6LzBnRmZ3RUpucHMxem95WnRkYkVlQXJQNER3cDRZVkttb1lBdEIrZlB6cFZ3R25SSEE5UjROa2U2cGJTeTJod2c2UmI3UnN0QzZiN2Y2cENBYTlqaEhvQXhtdjM5UERPU2tDdWpHMmJIQ2N1cVRldVQ4a3hDSEE9PSIsInZlYyI6InNWbzZrejZRa09iS0tDeDUiLCJ0YWciOiJ1eDNnbjEwNEdUWXpvV1J2TTZVck1BPT0ifQ==

Localization

Overview

In addition to using URL parameters, the web application itself can change the localization settings. This allows users to switch languages directly within the application.

Supported Languages

The same set of languages is supported as with the URL parameter method:

• English (en)

• Spanish (es)

• Indonesian (id)

• Korean (ko)

• Japanese (ja)

Usage Examples

You can pass the language in the URL using lang parameter, refer to this API documentation

https://api.tyrads.com/api/v3.0/auth?lang=en

Usage

1. Access the Localization Settings: Navigate to the settings or preferences section of the web application.

2. Select Language: Choose your preferred language from the list of supported languages.

3. Apply Changes: Save your selection to update the application's language.