Integration Guide

iFrame, Postback, Offers API, Web SDK and Android SDK

BASE URL https://pro.adswedmedia.com

iFrame Integration

Easiest

Apply

Create a publisher account and submit your application for review.

Get Keys

After approval, copy your Public Key and Secret Key from Setup.

Embed

Paste the tracking link in an iFrame and configure your postback URL.

Embed Code

Replace YOUR_KEY with your Public Key and USER_ID with your user's unique identifier.

HTML

<iframe
  src="https://pro.adswedmedia.com/offer/YOUR_KEY/USER_ID"
  width="100%"
  height="700"
  frameborder="0"
  allow="clipboard-write"
></iframe>

Postback (Server-to-Server)

Security

When a user completes an offer, we send a HTTP GET request to your postback URL with these parameters.

Parameters

Parameter	Type	Description
subId	string	Your user's unique identifier
transId	string	Unique transaction ID (use for deduplication)
reward	number	Amount of virtual currency to credit
payout	number	Offer payout in USD
signature	string	MD5 hash for verification
status	integer	`1` = credit `2` = chargeback (subtract)
offer_id	string	Completed offer ID
offer_name	string	Completed offer name
round_reward	number	Reward rounded to your site's decimal setting
userIp	string	User's IP address
country	string	ISO 2-letter country code
uuid	string	Unique click ID
event_id	string	Event ID (multi-reward offers only)
event_name	string	Event name (multi-reward offers only)

Signature Verification

Formula: MD5( subId + transId + reward + SECRET_KEY )

PHP

// Verify the postback signature
$secret    = 'YOUR_SECRET_KEY';
$subId     = $_GET['subId'] ?? '';
$transId   = $_GET['transId'] ?? '';
$reward    = $_GET['reward'] ?? '';
$signature = $_GET['signature'] ?? '';

if (md5($subId . $transId . $reward . $secret) != $signature) {
    echo "ERROR"; return;
}

// Prevent duplicate credits
if (isDuplicate($transId)) { echo "DUP"; return; }

// Credit or chargeback
if ($_GET['status'] == '1') {
    creditUser($subId, $reward);
} else {
    subtractUser($subId, $reward);
}
echo "OK";

Respond with OK for success or DUP for duplicates. We retry up to 5 times on timeout (60s max).

Offers API

API v2

GET/api/v1/offers

Rate limit: 10 requests/hour per site credentials. Returns X-RateLimit-Remaining header.

Parameters

Parameter	Required	Type	Description
site_key	required	string	Site public key
site_secret	required	string	Site secret key
type	optional	string	`offer` or `multireward`
limit	optional	integer	Results per page, 1-500. Default: 100
offset	optional	integer	Skip N results (pagination)
country	optional	string	ISO 2-letter code: `US`, `DE`, `BR`
device	optional	string	`android`, `ios`, `desktop`
min_payout	optional	float	Minimum USD payout
updated_since	optional	string	ISO 8601 date for incremental sync

Error Codes

MISSING_CREDENTIALS400Both site_key and site_secret are required

INVALID_CREDENTIALS401No site found with the provided keys

SITE_PENDING403Site is pending approval

INVALID_TYPE422Only offer or multireward accepted

INVALID_DATE422updated_since must be a valid ISO 8601 date

RATE_LIMIT_EXCEEDED429Too many requests

Response Format

JSON

{
  "success": true,
  "version": "v1",
  "total": 245,
  "offset": 0,
  "limit": 100,
  "has_more": true,
  "offers": [
    {
      "id": 1,
      "title": "Install Game App",
      "description": "Download and reach level 5",
      "image": "https://pro.adswedmedia.com/asset/images/offers/example.jpg",
      "payout": 0.85,
      "currency": "USD",
      "level": "easy",
      "stars": 4,
      "categories": ["games"],
      "countries": ["US", "GB"],
      "devices": ["android", "ios"],
      "payment_term": "net30",
      "android_min_os": "8.0",
      "ios_min_os": null,
      "tracking_url": "https://pro.adswedmedia.com/redirect/manual-offer/1/user/{user_id}/site/KEY",
      "updated_at": "2026-03-15T14:30:00+00:00",
      "created_at": "2026-03-01T10:00:00+00:00"
    }
  ]
}

GET/api/v1/status

Health Check

Returns API status, offer counts, and your site status. Same auth params.

JSON

{
  "success": true,
  "status": "operational",
  "data": {
    "offers_available": 245,
    "multireward_available": 38,
    "site_status": "active",
    "rate_limit_per_hour": 10
  }
}

Report API

Fetch traffic and conversion reports for your site. Get daily, per-offer, or per-country breakdowns.

Overview

Endpoint	`GET https://pro.adswedmedia.com/api/v1/reports`
Method	GET
Auth	site_key + site_secret (query params)

Query Parameters

Parameter	Required	Description
`site_key`	Required	Your site key
`site_secret`	Required	Your site secret
`from`	Optional	Start date (YYYY-MM-DD). Default: 30 days ago
`to`	Optional	End date (YYYY-MM-DD). Default: today
`group_by`	Optional	`day`, `offer`, or `country`. Default: day
`offer_id`	Optional	Filter by specific offer ID

Response Format

{
  "success": true,
  "site": { "id": 10, "key": "YOUR_KEY" },
  "period": { "from": "2026-03-01", "to": "2026-04-03" },
  "summary": {
    "clicks": 150,
    "conversions": 12,
    "revenue": 45.50,
    "chargebacks": 1,
    "pending": 20.00,
    "paid": 25.50,
    "cvr": 8.0,
    "epc": 0.3033
  },
  "group_by": "day",
  "breakdown": [
    {
      "date": "2026-04-01",
      "clicks": 50,
      "conversions": 4,
      "revenue": 15.25,
      "chargebacks": 0,
      "cvr": 8.0,
      "epc": 0.305
    }
  ]
}

Summary Fields

Field	Type	Description
`clicks`	integer	Total clicks in period
`conversions`	integer	Total conversions
`revenue`	number	Total revenue (USD)
`chargebacks`	integer	Total chargebacks
`pending`	number	Pending payout (USD)
`paid`	number	Paid payout (USD)
`cvr`	number	Conversion rate (%)
`epc`	number	Earnings per click (USD)

Breakdown Fields (group_by=day)

Field	Description
`date`	Date (YYYY-MM-DD)
`clicks`, `conversions`, `revenue`, `chargebacks`, `cvr`, `epc`	Same as summary, per day

Breakdown Fields (group_by=offer)

Field	Description
`offer_id`	Offer identifier
`offer_name`	Offer title
`clicks`, `conversions`, `revenue`, `chargebacks`, `cvr`, `epc`	Stats per offer

Breakdown Fields (group_by=country)

Field	Description
`country`	Country name
`clicks`, `conversions`, `revenue`, `chargebacks`	Stats per country

Code Examples

Node.js

const axios = require("axios");

async function getReport() {
  const { data } = await axios.get("https://pro.adswedmedia.com/api/v1/reports", {
    params: {
      site_key: "YOUR_SITE_KEY",
      site_secret: "YOUR_SITE_SECRET",
      from: "2026-04-01",
      to: "2026-04-03",
      group_by: "day"  // or "offer" or "country"
    }
  });

  if (data.success) {
    console.log("Summary:", data.summary);
    console.log(`Clicks: ${data.summary.clicks}`);
    console.log(`Revenue: $${data.summary.revenue}`);
    console.log(`CVR: ${data.summary.cvr}%`);

    data.breakdown.forEach(row => {
      console.log(`${row.date}: ${row.clicks} clicks, ${row.conversions} conv, $${row.revenue}`);
    });
  }
}

getReport();

PHP

$response = file_get_contents(
    "https://pro.adswedmedia.com/api/v1/reports?" . http_build_query([
        "site_key"    => "YOUR_KEY",
        "site_secret" => "YOUR_SECRET",
        "from"        => "2026-04-01",
        "to"          => "2026-04-03",
        "group_by"    => "offer",
    ])
);
$data = json_decode($response, true);

echo "Revenue: $" . $data["summary"]["revenue"];
foreach ($data["breakdown"] as $row) {
    echo $row["offer_name"] . ": " . $row["clicks"] . " clicks\n";
}

Web SDK

JS v1.0.0

Quick Start

HTML

<!-- 1. Load the SDK -->
<script src="https://pro.adswedmedia.com/sdk/v1/adsw.js"></script>

<!-- 2. Add a button -->
<button id="earn-btn">Earn Rewards</button>

<script>
  // 3. Initialize
  ADSW.init({
    appKey: 'YOUR_APP_KEY',
    userId: 'USER_123',
    appName: 'My App',
    enablePolling: true
  });

  // 4. Open offerwall on click
  document.getElementById('earn-btn').onclick = function() {
    ADSW.show();
  };

  // 5. Listen for rewards
  ADSW.on('reward', function(data) {
    console.log('Earned', data.reward, data.currency);
  });
</script>

For embed mode (inline): ADSW.show({ mode: 'embed', container: '#my-div', height: '700px' })

Configuration

Option	Type	Default	Description
appKey	string	-	required Your API key
userId	string	-	required Stable user ID
appName	string	`"Offerwall"`	Header title
baseUrl	string	Auto	Override API base URL
locale	string	-	Language code (`en`, `es`, `fr`)
currency	string	-	Currency name for display
enablePolling	boolean	`false`	Auto-poll rewards
pollInterval	number	`15000`	Poll interval (ms)
showRewardToast	boolean	`true`	Toast notification
debug	boolean	`false`	Console logging

Events

Event	Callback Data	Description
init	`{ sessionId, site }`	SDK initialized
ready	`{}`	Offerwall iframe loaded
open	-	Offerwall opened
close	-	Offerwall closed
reward	`{ transactionId, offerId, offerName, reward, payout, currency, timestamp }`	User earned a reward
offer_click	`{ offerId, offerName, payout }`	User clicked an offer
error	`{ message }`	Error occurred

Methods

Method	Description
ADSW.init(config, cb)	Initialize the SDK
ADSW.show(options)	Display offerwall (modal or embed)
ADSW.hide()	Close the modal
ADSW.on(event, fn)	Register event listener
ADSW.off(event, fn)	Remove event listener
ADSW.isReady()	Returns `true` if SDK initialized
ADSW.isVisible()	Returns `true` if offerwall showing
ADSW.getSessionId()	Returns current session token
ADSW.destroy()	Cleanup all SDK elements

Android SDK

Native

POST/api/sdk/v1/init

Init Session

Creates a 24-hour session. Returns a token and the offerwall URL.

Param	Required	Description
app_key	required	Your site public key
user_id	required	Unique user identifier
sdk_version	optional	SDK version for analytics
domain	optional	App package name or domain

Response

{
  "success": true,
  "session_id": "a1b2c3d4e5f6...64-char-hex",
  "site": {
    "name": "My Reward App",
    "currency": "coins",
    "decimals": 2
  },
  "config": {
    "offerwall_url": "https://pro.adswedmedia.com/offer/KEY/user123",
    "poll_interval": 15
  }
}

GET/api/sdk/v1/rewards

Poll Rewards

Returns new rewards since last poll. Send app_key, user_id, and session.

Response

{
  "success": true,
  "count": 1,
  "rewards": [{
    "transactionId": "txn_12345",
    "offerId": 42,
    "offerName": "Install Game",
    "reward": 150.00,
    "payout": 0.85,
    "currency": "coins",
    "timestamp": "2026-03-16T10:30:00+00:00"
  }]
}

Poll every 15 seconds. Session expired? Call /init again. Error code: SESSION_EXPIRED

S2S Callbacks

Optional

Configure a callback URL in your site settings. We send a GET request with HMAC-SHA256 signature.

Param	Description
event	Always `reward`
transaction_id	Unique transaction ID
site_key	Your site public key
user_id	User who completed the offer
offer_id	Completed offer ID
offer_name	Completed offer name
reward	Reward amount (your currency)
payout	Payout in USD
currency	Your site's currency name
timestamp	ISO 8601 timestamp
signature	HMAC-SHA256 for verification

Signature: HMAC-SHA256( transaction_id : user_id : reward, SECRET )

PHP

$secret   = 'YOUR_SECRET';
$expected = hash_hmac('sha256',
    $_GET['transaction_id'] . ':' . $_GET['user_id'] . ':' . $_GET['reward'],
    $secret
);

if (!hash_equals($expected, $_GET['signature'])) {
    http_response_code(403); echo 'Invalid'; exit;
}

creditUser($_GET['user_id'], $_GET['reward']);
echo 'OK';

Platform Plugins

Ready-to-install plugins for WordPress, WooCommerce, Shopify, and Wix

Our platform plugins let you integrate the AdswedMedia offerwall into your website with zero coding required. Each plugin loads our remote Web SDK and handles user identification, reward notifications, and banner ads automatically.

How it works: All plugins load the SDK from adswedmedia.com/sdk/v1/adsw.js remotely. No local SDK copies — always up to date.

WordPress

Install the adswedmedia-offerwall plugin, enter your API key in Settings → AdswedMedia, and use shortcodes to display the offerwall on any page or post.

Installation:

Upload adswedmedia-offerwall to /wp-content/plugins/
Activate via Plugins menu
Go to Settings → AdswedMedia and enter your API Key
Add the shortcode to any page

Shortcode	Description
`[adswedmedia_offerwall]`	Button that opens the offerwall modal
`[adswedmedia_offerwall mode="embed"]`	Embed offerwall directly on the page
`[adswedmedia_offerwall button_text="Earn"]`	Custom button text
`[adswedmedia_banner size="300x250"]`	Banner ad (sizes: 300x250, 728x90, 320x50, 160x600, 468x60)

Also available as a sidebar widget via Appearance → Widgets.

Setting	Description	Default
API Key	Your site `st_key` from the publisher dashboard	required
Base URL	AdswedMedia server URL	`https://adswedmedia.com`
Display Mode	Modal (popup) or Embed (inline)	Modal
Button Text	Text shown on the offerwall button	Earn Rewards
Reward Polling	Auto-show toast when user earns rewards	Enabled
Debug Mode	Enable SDK console logging	Disabled

User ID: Logged-in users get wp_{user_id}. Anonymous visitors get a cookie-based ID (anon_{uuid}, 30-day expiry).

WooCommerce

Everything from the WordPress plugin plus store credit, a "My Rewards" tab in the customer account, and a S2S webhook endpoint for server-side reward verification.

Installation:

Upload adswedmedia-woocommerce to /wp-content/plugins/ (WooCommerce must be active)
Go to WooCommerce → Settings → AdswedMedia tab
Enter your API Key and Callback Secret
Copy the S2S Callback URL shown in settings and paste it in your AdswedMedia dashboard as SDK Callback URL

Store Credit

Convert reward points to checkout discounts. Configurable conversion rate (e.g. 100 pts = $1).

My Rewards Tab

Balance, embedded offerwall, transaction history, and redeem button in My Account.

S2S Webhook

REST endpoint with HMAC-SHA256 signature verification and duplicate protection.

Callback URL Format

https://your-store.com/wp-json/adswedmedia/v1/callback

User ID: WooCommerce customers get wc_{user_id} prefix (different from wp_ to avoid collisions).

Shopify

A Theme App Extension that lets you add the offerwall and banners via the Shopify theme editor — drag & drop, no code required.

Installation:

Install the AdswedMedia app from the Shopify App Store
Go to Online Store → Customize
Click Add section and select AdswedMedia Offerwall or AdswedMedia Banner
Enter your API Key in the block settings
Save

Offerwall Block

Modal button or embedded offerwall. Configure display mode, button text, height, and reward notifications.

Banner Block

Banner ads in 5 sizes. Select size from dropdown, banners load and track impressions automatically.

User ID: Logged-in customers use shp_{customer.id}. Guests get a localStorage-based anonymous ID.

Wix

A Wix Blocks app with dashboard settings, offerwall widget, banner widget, and server-side reward handling via Velo HTTP functions.

Installation:

Install AdswedMedia Offerwall from the Wix App Market
Open the app's dashboard page and enter your API Key
Use the Wix Editor to add the AdswedMedia Offerwall or AdswedMedia Banner widget to any page
Optionally configure the Callback Secret for S2S reward verification

Dashboard Settings

API Key, Base URL, display mode, button text, polling, and callback secret.

Widgets

Offerwall (modal or embed) and Banner (5 sizes) — add via Wix Editor.

S2S Callbacks

Velo HTTP function with HMAC verification. Stores rewards in Wix Data collections.

Callback URL Format

https://your-site.com/_functions/adswedmediaCallback

User ID: Wix Members use wix_{member._id}. Anonymous visitors get a localStorage-based ID.

All Plugins Share

Remote SDK — always up to date

Modal & embed display modes

5 banner ad sizes

Automatic reward toast notifications

Logged-in & anonymous user support

Platform-prefixed user IDs (no collisions)

Lightweight (<50KB per plugin)

Settings UI in each platform's admin

Native Banner API

Use this endpoint to display banner ads in mobile apps (Flutter, Kotlin, Swift, React Native) or any platform that can make HTTP requests. Returns JSON with image URLs — no JavaScript required.

Endpoint

GET https://pro.adswedmedia.com/api/banners/v1/native

Parameters

Param	Required	Description
`site_key`	Yes	Your site/app key from the publisher dashboard
`sub_id`	Yes	Unique user ID in your app (for tracking & anti-fraud)
`size`	No	Banner size. Default: `320x50`. Options: `320x50`, `300x250`, `728x90`
`limit`	No	Max banners to return (1-5). Default: `1`

Response

{
  "success": true,
  "banners": [
    {
      "id": 42,
      "image_url": "https://pro.adswedmedia.com/asset/storage/banners/example.jpg",
      "click_url": "https://pro.adswedmedia.com/api/banners/v1/click?campaign_id=42&site_key=YOUR_KEY&sub_id=123",
      "impression_url": "https://pro.adswedmedia.com/api/banners/v1/impression?campaign_id=42&site_key=YOUR_KEY&sub_id=123",
      "width": 320,
      "height": 50
    }
  ]
}

Integration Steps

Call the endpoint to get banner data
Display the image_url in your app
When the banner is visible, fire a GET request to impression_url (for CPM tracking)
When the user taps the banner, open click_url in the browser

Flutter Example

import 'dart:convert';
import 'package:http/http.dart' as http;
import 'package:url_launcher/url_launcher.dart';

class BannerAd {
  final int id;
  final String imageUrl, clickUrl, impressionUrl;
  final int width, height;

  BannerAd.fromJson(Map<String, dynamic> json)
      : id = json['id'],
        imageUrl = json['image_url'],
        clickUrl = json['click_url'],
        impressionUrl = json['impression_url'],
        width = json['width'],
        height = json['height'];
}

Future<BannerAd?> fetchBanner(String siteKey, String userId) async {
  final uri = Uri.parse(
    'https://pro.adswedmedia.com/api/banners/v1/native'
    '?site_key=$siteKey&sub_id=$userId&size=320x50&limit=1',
  );
  final res = await http.get(uri);
  if (res.statusCode != 200) return null;
  final data = jsonDecode(res.body);
  final banners = data['banners'] as List;
  if (banners.isEmpty) return null;
  return BannerAd.fromJson(banners[0]);
}

// Display: Image.network(banner.imageUrl)
// On show: http.get(Uri.parse(banner.impressionUrl))
// On tap:  launchUrl(Uri.parse(banner.clickUrl))

Kotlin (Android) Example

val url = "https://pro.adswedmedia.com/api/banners/v1/native" +
    "?site_key=$siteKey&sub_id=$userId&size=320x50&limit=1"

val response = URL(url).readText()
val json = JSONObject(response)
val banners = json.getJSONArray("banners")
if (banners.length() > 0) {
    val banner = banners.getJSONObject(0)
    val imageUrl = banner.getString("image_url")
    val clickUrl = banner.getString("click_url")
    val impressionUrl = banner.getString("impression_url")
    // Load imageUrl into ImageView
    // Fire GET to impressionUrl on display
    // Open clickUrl in browser on tap
}

Swift (iOS) Example

let url = URL(string: "https://pro.adswedmedia.com/api/banners/v1/native?site_key=\(siteKey)&sub_id=\(userId)&size=320x50&limit=1")!

URLSession.shared.dataTask(with: url) { data, _, _ in
    guard let data = data,
          let json = try? JSONSerialization.jsonObject(with: data) as? [String: Any],
          let banners = json["banners"] as? [[String: Any]],
          let banner = banners.first else { return }

    let imageUrl = banner["image_url"] as! String
    let clickUrl = banner["click_url"] as! String
    let impressionUrl = banner["impression_url"] as! String
    // Load imageUrl into UIImageView
    // Fire GET to impressionUrl on display
    // Open clickUrl with UIApplication.shared.open() on tap
}.resume()