Developer Portal & API Docs

Welcome to the WateenX Developer Architecture. Our high-throughput monetization infrastructure allows digital publishers, gaming studios, and GPT rewards platforms to integrate interactive offerwalls and programmatic REST feeds seamlessly.

Our platform supports two primary integration avenues depending on your application requirements:

Each registered property is provisioned with a cryptographically generated API Key and Secret Key. All API endpoints and webhook verification mechanisms rely on these credentials.

IP Whitelisting (Optional)

For enhanced protection against compromised credentials, you can configure allowed outbound server IP addresses inside your property settings. If enabled, any API calls originating outside your designated IP whitelist will be rejected with HTTP 403 Forbidden.

The hosted offerwall provides a responsive user interface with built-in device filtering, localized translations, offer sorting, and immediate transaction tracking.

Direct URL Format

https://wateenx.com/offerwall/pub_live_xxxxxxxxxxxxxxxxxxxx/[USER_ID]

Replace [USER_ID] with your application's unique user identifier (e.g. database ID, username, or sub-account identifier). This value is preserved across all clicks and passed back in webhook callbacks as {subId}.

HTML iFrame Embedding Code

<!-- WateenX Responsive Offerwall Frame -->
<iframe 
    src="https://wateenx.com/offerwall/pub_live_xxxxxxxxxxxxxxxxxxxx/USER_ID_HERE" 
    width="100%" 
    height="900px" 
    frameborder="0" 
    scrolling="yes" 
    style="border: none; border-radius: 16px; box-shadow: 0 10px 30px rgba(0,0,0,0.06);">
</iframe>

A postback is an asynchronous, server-to-server HTTP request sent automatically by WateenX to your callback script whenever a user finishes an offer or survey.

Supported Macro Parameter Tokens

You can embed any of the following macros in your postback URL. Our dispatch engine replaces each token with live conversion parameters:

To guarantee that incoming webhooks are authentic and sent by WateenX (and not spoofed by malicious third parties), you must verify the {signature} parameter using your secret key.

Multi-Language Verification Snippets

<?php
// Your property secret key
$SECRET_KEY = "sec_live_xxxxxxxxxxxxxxxxxxxxxxxx";

// Receive GET or POST parameters
$subId     = $_REQUEST['subId'] ?? '';
$transId   = $_REQUEST['transId'] ?? '';
$reward    = $_REQUEST['reward'] ?? '';
$payout    = $_REQUEST['payout'] ?? '';
$status    = $_REQUEST['status'] ?? '';
$signature = $_REQUEST['signature'] ?? '';

// Compute expected V2 MD5 signature
$expectedSig = md5($subId . $transId . $reward . $payout . $status . $SECRET_KEY);

if (hash_equals($expectedSig, $signature)) {
    // Signature is valid! Check if transaction already credited
    if ($status == 1) {
        // Credit user $subId with $reward points
    } elseif ($status == 2) {
        // Reversal / Chargeback: deduct points
    }
    echo "OK";
} else {
    http_response_code(403);
    echo "INVALID_SIGNATURE";
}

const express = require('express');
const crypto  = require('crypto');
const app     = express();

const SECRET_KEY = 'sec_live_xxxxxxxxxxxxxxxxxxxxxxxx';

app.get('/api/postback', (req, res) => {
    const { subId, transId, reward, payout, status, signature } = req.query;

    // Calculate V2 hash
    const payload = `\${subId}\${transId}\${reward}\${payout}\${status}\${SECRET_KEY}`;
    const expected = crypto.createHash('md5').update(payload).digest('hex');

    if (expected.toLowerCase() === (signature || '').toLowerCase()) {
        // Credit user
        return res.status(200).send('OK');
    }
    return res.status(403).send('INVALID_SIGNATURE');
});

from flask import Flask, request, abort
import hashlib

app = Flask(__name__)
SECRET_KEY = "sec_live_xxxxxxxxxxxxxxxxxxxxxxxx"

@app.route('/api/postback', methods=['GET', 'POST'])
def handle_postback():
    sub_id    = request.args.get('subId', '')
    trans_id  = request.args.get('transId', '')
    reward    = request.args.get('reward', '')
    payout    = request.args.get('payout', '')
    status    = request.args.get('status', '')
    signature = request.args.get('signature', '')

    # Calculate V2 hash
    payload = f"{sub_id}{trans_id}{reward}{payout}{status}{SECRET_KEY}"
    expected = hashlib.md5(payload.encode('utf-8')).hexdigest()

    if expected.lower() == signature.lower():
        # Credit user
        return "OK", 200
    return "INVALID_SIGNATURE", 403

For publishers creating custom native mobile apps or tailored reward lobbies, query our real-time offer inventory programmatically via our JSON REST endpoint.

Query Parameters

Multi-Language API Request Examples

curl -X GET "https://wateenx.com/api/v1/offers?user_id=usr_12345&device=mobile&limit=30" \
     -H "X-API-Key: pub_live_xxxxxxxxxxxxxxxxxxxx" \
     -H "X-API-Secret: sec_live_xxxxxxxxxxxxxxxxxxxxxxxx"

<?php
$ch = curl_init();
curl_setopt_array($ch, [
    CURLOPT_URL => "https://wateenx.com/api/v1/offers?user_id=usr_12345&limit=25",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "X-API-Key: pub_live_xxxxxxxxxxxxxxxxxxxx",
        "X-API-Secret: sec_live_xxxxxxxxxxxxxxxxxxxxxxxx",
        "Accept: application/json"
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

const response = await fetch('https://wateenx.com/api/v1/offers?user_id=usr_12345&limit=25', {
    method: 'GET',
    headers: {
        'X-API-Key': 'pub_live_xxxxxxxxxxxxxxxxxxxx',
        'X-API-Secret': 'sec_live_xxxxxxxxxxxxxxxxxxxxxxxx',
        'Accept': 'application/json'
    }
});

const result = await response.json();
console.log(result.data);

import requests

headers = {
    'X-API-Key': 'pub_live_xxxxxxxxxxxxxxxxxxxx',
    'X-API-Secret': 'sec_live_xxxxxxxxxxxxxxxxxxxxxxxx'
}

params = {
    'user_id': 'usr_12345',
    'limit': 25
}

res = requests.get('https://wateenx.com/api/v1/offers', headers=headers, params=params)
data = res.json()

Standard JSON Response Example

{
  "success": true,
  "total_offers": 48,
  "page": 1,
  "limit": 25,
  "data": [
    {
      "id": "1492",
      "name": "Raid: Shadow Legends",
      "description": "Install the game, open two sacred shards within 14 days.",
      "instructions": "New users only. Reach Level 10 and open shards.",
      "category": "Games",
      "payout": 28.5000,
      "reward": 28500.00,
      "currency_name": "Points",
      "image": "https://wateenx.com/assets/img/offers/raid.png",
      "os": "android",
      "countries": ["US", "CA", "GB", "DE"],
      "click_url": "https://wateenx.com/click/a849fbc8921e..."
    }
  ]
}

Use this real-time builder to construct a formatted callback URL with all necessary conversion macros. Copy the result and paste it into your property settings in the Web Properties portal.