SDK - Affiliate Offer Table

The Affiliate Offer Table SDK is a simple utility that displays affiliate offers in a table form based on API data. Simply enter your affiliate API information, and this SDK will automatically display the offers in an organized table structure. It is a quick and simple approach to show offer information without extensive setup.

Setup

Instructions to Enable the Offer18 Affiliate Offer Table SDK

1. Create a New HTML File

2. Add the SDK Configuration and Script

Inside the <body> tag, add the following script to configure and load the Offer18 SDK. Replace the placeholder values with your actual affiliate details:

<script>
  OFFER18_API_CONFIG = {
    "aid": "<--AFFILIATE-ID-->",  // Replace with your Affiliate ID
    "mid": "<--ACCOUNT-ID-->",             // Replace with your Account ID (MID)
    "key": "<--API-KEY-->"             // Replace with your API Key
  };
</script>
<script src="https://web-resources.offer18.net/sdk/web/affiliate-api/OfferTable.js"></script>

3. Add Your Affiliate API Details

In the OFFER18_API_CONFIG object

aid: Enter your unique Affiliate ID.
mid: Enter your Account ID (MID).
key: Enter your API Key.

These fields are mandatory for Affiliate Offer Table SDK

Additional Configuration Options

You can enhance the OFFER18_API_CONFIG object by adding optional parameters to customize the display and filtering of offers in the Affiliate Offer Table. Below is a list of additional configuration options available.

Parameter

Type

Description

fields

Array

Specifies the fields to display in the table, in the order provided. Available Fields:

"offerid", "name", "logo", "status", "category", "price", "currency", "model", "date_start", "date_end", "preview_url", "offer_terms", "offer_kpi",  "capping", "events", "payout", "impression_url", "click_url", "authorized", "creatives", "targeting"

offer_id

String

Comma-separated string of specific offer IDs to display. Shows only these offers.

page

String

Specifies the page number for pagination.

Example File

Here's an example of a fully configured OFFER18_API_CONFIG object with both required and optional parameters:

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>

<body>
  <script>
    OFFER18_API_CONFIG = {
      "aid": "12345",
      "mid": "67890",
      "key": "000000000000000000000000000000",
       
       // Optional Configuration
      "fields": ["offerid", "name", "logo", "status", "category", "price", "currency", "model", "date_start", "date_end", "preview_url", "offer_terms", "offer_kpi",  "capping", "events", "payout", "impression_url", "click_url", "authorized", "creatives", "targeting"],        // Array of fields to display, in the desired order
      "offer_id": "123,456,789",             // Comma-separated string of specific offer IDs
      "page": "1",                           // Page number to display
      "category": "Finance",                 // Category of offers to display
      "model": "CPA",                        // Model of the offer (e.g., CPA, CPL)
      "country": "US,CA",                    // Comma-separated list of country codes
      "offer_status": "1",                   // Set to "1" to show only active offers
      "authorized": "1"                      // Set to "1" to display only authorized offers
    };
  </script>
  <script src="https://web-resources.offer18.net/sdk/web/affiliate-api/OfferTable.js"></script>
</body>

</html>

PreviousOTP API NextIntegration

Last updated 1 year ago

Was this helpful?