CPAlead Publisher API

Publisher API Documentation

Use these APIs to pull offers, check conversions, and download reversals. If you want, you can also use the OpenAPI file below with your own API tools.

OpenAPI JSON API Oferte API Conversii API Anulări

This page is public. Replace placeholder values like {PUBLISHER_ID} and {API_KEY} with your own values after you sign in.

Quick Facts

Formats: JSON and JSONP
Offers Default Limit: 2500
Native CPC: Not returned by the Offers API
OpenAPI File: https://www.cpalead.com/api/openapi.json

On This Page

OpenAPI File

You can use this file if you want to import the API into your own tools.

Overview

What this API is designed for

Offer Sync

Pull available offers, filter by device or country, and use updated_since for incremental refreshes.

Tracking Safety

The Offers API never returns native CPC offers. Boost-click offers can appear, but they keep their normal rank.

OpenAPI File

The public OpenAPI file is available at /api/openapi.json .

API Oferte

Returnează o listă JSON cu ofertele disponibile. Ofertele evidențiate pot apărea primele. După aceea, valorile mai mici ale offer_rank apar primele.

Clasament & plăți pe țară

Fiecare ofertă include un offer_rank în care 1 este oferta cu cel mai mare rang. Ofertele evidențiate pot apărea primele. După aceea, rezultatele rămân în ordinea offer_rank, de la mici la mari.
Unele oferte plătesc sume diferite în funcție de țară. Dacă o ofertă include o listă "payouts_per_country", folosiți plata care se potrivește codului de țară din două litrere al utilizatorului (de ex., US, CA, GB). Dacă țara lor nu se află în listă, folosiți plata implicită afișată în "amount".

Note despre API-ul de Oferte

Ofertele CPC nu sunt returnate de acest API.
Dacă o ofertă are boost clicks, își păstrează totuși rangul normal. Nu este mutată în partea de sus doar pentru că are boost clicks.
Folosirea linkului exact returnat de API păstrează cea mai bună atribuire. Dacă salvați sau reconstruiți linkurile în sistemul dvs., clicurile tot funcționează.

Endpoint

https://www.cpalead.com/api/offers?id={PUBLISHER_ID}

Parametri de interogare HTTP disponibili

Parametru HTTP	Descriere
id	Required. Your publisher ID.
country	Afișați doar ofertele din țară, transmițând codul țării ISO din două litrere Folosiți `country=user` pentru a obține automat oferte pentru țara utilizatorului
limit	Limitați numărul de oferte returnate. Acest lucru poate accelera apelurile API. Valoarea implicită este 2500, iar valoarea maximă este 5000.
type	Acest API nu returnează oferte CPC. Implicit, returnează oferte CPA, CPI și CPE. Puteți solicita și CPR cu o listă separată prin virgulă, de exemplu `&type=cpi,cpe,cpr`
updated_since	Only return offers updated on or after this date. You can use YYYY-MM-DD or a full ISO date and time, for example `&updated_since=2026-04-01T00:00:00Z`
fields	Only return the offer fields you need. Use a comma-separated list, for example `&fields=id,title,link,amount,offer_rank` Available fields: `id, title, description, conversion, device, daily_cap, is_fast_pay, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country`
offerwall_offers	Boolean (adevărat\|fals). Folosiți adevărat dacă doriți și oferte marcate pentru offerwall-uri. Ofertele CPC tot nu sunt incluse, iar ofertele cu boost-click păstrează rangul lor normal.
device	Folosiți acest lucru doar dacă nu utilizați direcționarea automată după dispozitiv. Implicit, API-ul poate returna toate tipurile de dispozitive. Folosiți acest câmp pentru a returna doar anumite tipuri de dispozitive. Valori disponibile: ios, android, mobile și desktop. Device poate fi și o listă separată prin virgulă, de exemplu: `&device=ios,android,mobile,desktop` Pentru a obține doar oferte CPI / CPE (care necesită doar instalarea pentru conversie - folosiți device=ios,android Folosiți `device=user` pentru a obține automat oferte pentru dispozitivul utilizatorului
subid / subid2 / subid3	Urmărirea SubID vă permite să trimiteți date suplimentare când un utilizator face clic pe linkurile dvs. de afiliat, prin adăugarea unei etichete la sfârșitul linkurilor dvs. de afiliat, acest parametru va completa automat subid-ul în linkul dvs. de tracking. Puteți folosi SubID-uri pentru a segmenta lead-urile, a optimiza campaniile și a îmbunătăți conversiile, iată câteva exemple: ID-uri Sub-Affiliate, surse (Organic, PPC, Email etc), cuvinte cheie, locații, etc... O a doua variabilă subid pentru date suplimentare O a treia variabilă subid pentru date suplimentare
gaid / idfa	Dacă aveți un Google Advertising ID (GAID) pentru mobil, folosiți această variabilă pentru a completa automat gaid-ul în linkul dvs. de tracking Dacă aveți un Apple Identifier For Advertisers (IDFA) pentru mobil, folosiți această variabilă pentru a completa automat idfa-ul în linkul dvs. de tracking
format / callback	Format JSON sau JSONP. JSON este implicit Numele funcției de callback JSONP. Folosit doar pentru formatul JSONP. Dacă folosiți jQuery getJSON, folosiți callback=? și jQuery va completa automat numele funcției pentru dvs. Consultați exemplul JSONP

Exemplu de răspuns

{
    "status": "success",
    "number_offers": 2,
    "country": "US",
    "devices": null,
    "offers": [
        {
            "id": 999001,
            "title": "QuizBlitz Pro",
            "description": "Test your knowledge and win rewards!",
            "conversion": "Complete Level 5 (New Users Only)",
            "device": "android",
            "daily_cap": 50,
            "is_fast_pay": true,
            "link": "https://{tracking_domain}/view.php?id=999001&pub={PUBLISHER_ID}&_src=api&_src_sig={SIGNATURE}",
            "preview_link": "https://example.com/offerblast",
            "amount": 1.2,
            "payout_currency": "USD",
            "payout_type": "CPE",
            "countries": [
                "US",
                "CA",
                "GB",
                "AU",
                "NZ"
            ],
            "epc": 0.95,
            "creatives": {
                "url": "https://{assets_domain}/images/offerblast.png"
            },
            "offer_rank": 7,
            "payouts_per_country": {
                "US": 1.2,
                "CA": 1.1,
                "GB": 0.9
            }
        },
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "conversion": "Install, open & keep for 2 days (New Users Only)",
            "device": "ios",
            "daily_cap": 100,
            "is_fast_pay": false,
            "link": "https://{tracking_domain}/view.php?id=999002&pub={PUBLISHER_ID}&_src=api&_src_sig={SIGNATURE}",
            "preview_link": "https://example.com/photomaster",
            "amount": 0.85,
            "payout_currency": "USD",
            "payout_type": "CPI",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12
        }
    ]
}

Exemplu de cod

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>CPAlead Offers API Example</title>
</head>
<body>
    <div id="offer-list">Loading offers...</div>

document.getElementById("offer-list").innerHTML = html || "No offers found.";
            })
            .catch(() => {
                document.getElementById("offer-list").innerText = "Failed to load offers.";
            });
    </script>
</body>
</html>

API Conversii

Limită: 1 cerere pe minut
API-ul de Conversii vă permite să trimiteți ping către CPAlead pentru a testa conversiile, util pentru crearea de aplicații personalizate. Transmiteți subid ca subid sau adresă IP, sau "user" pentru ca sistemul nostru să folosească adresa IP a clientului care apelează acest script (util pentru apeluri JSONP)
Pentru serviciul de conversii de tip push (Server-to-Server Postback), consultați Documentația noastră Postback

Endpoint

https://www.cpalead.com/api/conversions?id={PUBLISHER_ID}&api_key={API_KEY}

Parametri de interogare HTTP disponibili

Parametru HTTP	Descriere
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Necesar. Căutare conversie pe baza subid-ului, transmiteți subid sau adresa IP a utilizatorului, transmiteți "user" pentru a folosi adresa IP a clientului care apelează acest script (util pentru apeluri JSONP)
offer_id	Opțional. Va verifica conversia doar pentru acest ID de ofertă (campanie)
format / callback	Format JSON sau JSONP. JSON este implicit Numele funcției de callback JSONP. Folosit doar pentru formatul JSONP. Dacă folosiți jQuery getJSON, folosiți callback=? și jQuery va completa automat numele funcției pentru dvs. Consultați exemplul JSONP

Exemplu de răspuns

API Anulări

Limită: 1 cerere pe minut
Folosiți acest API pentru a descărca lista dvs. de lead-uri nevalide între două date. Util pentru sortarea traficului prost

Endpoint

https://www.cpalead.com/api/reversals?id={PUBLISHER_ID}&api_key={API_KEY}

Parametri de interogare HTTP disponibili

Parametru HTTP	Descriere
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Data de început de folosit la preluarea lead-urilor nevalide. Format: yyyy-mm-dd
end_date	Data de sfârșit de folosit la preluarea lead-urilor nevalide. Se poate prelua cel mult o lună odată
format / callback	Format JSON sau JSONP. JSON este implicit Numele funcției de callback JSONP. Folosit doar pentru formatul JSONP. Dacă folosiți jQuery getJSON, folosiți callback=? și jQuery va completa automat numele funcției pentru dvs. Consultați exemplul JSONP

Exemplu de răspuns