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

Doriți să gestionați campanii de advertiser?

API-ul pentru publisheri de pe această pagină este destinat preluării ofertelor și raportării pentru publisheri. Advertiserii pot folosi API-ul Campaign separat pentru a valida, crea, edita, porni și întrerupe temporar campanii self-service, inclusiv cu ajutorul unui agent AI.

Citiți ghidul API-ului Campaign pentru advertiseri

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
CPC API Access: Numai pentru membrii CPAlead Premium care au plătit
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

Câștigurile CPC și din clicuri boost necesită calitatea de membru CPAlead Premium plătită și acces CPC API activat. Ofertele boost își păstrează poziția normală în clasament.

OpenAPI File

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

API Oferte

Returns a JSON list of available offers. Lower offer_rank values show first.

Accesul dvs. CPC API

Autentificați-vă pentru a vedea accesul

De ce pot fi suspendate recompensele pe clic

Ofertele CPC și recompensele pentru clicuri boost pot fi limitate temporar dacă traficul dvs. generează clicuri repetate fără suficiente conversii CPA sau CPI eligibile. Această măsură protejează advertiserii de boți și trafic nevalid.

Ofertele CPC native și câmpurile pentru recompensele clicurilor boost sunt ascunse din fluxul API în timpul acestei suspendări. Conversiile CPA sau CPI eligibile ridică automat suspendarea. Ofertele de conversie eligibile rămân disponibile. Reîmprospătați fluxul complet pentru a actualiza disponibilitatea; celelalte verificări ale eligibilității clicurilor se aplică în continuare.

Starea eligibilității CPC

Fiecare răspuns reușit include cpc_eligibility, chiar dacă nu există oferte potrivite sau se folosește fields. access_enabled arată permisiunea contului. status poate fi not_enabled, eligible, conversion_limited sau unavailable. native_cpc_available și boost_click_rewards_available arată dacă aceste recompense sunt disponibile momentan pentru cont.

Comparați aceste valori la fiecare sincronizare. Când se schimbă, reîmprospătați fluxul complet fără updated_since și înlocuiți lista salvată. Starea nu garantează o recompensă pentru fiecare clic; celelalte verificări ale clicurilor se aplică în continuare.

Clasament & plăți pe țară

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
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".
Some offers pay by event. If an offer includes an "events" list, use each event name, description, and amount for the completed event. Event amounts are already adjusted to your publisher payout split.
CPA and CPI offers with conversion_mode=events pay each listed event once. The offer amount is the maximum total reward; events.amount is the reward for that event. Complete events within 30 days of the original click. The daily cap counts new acquisitions on the day of their first paid event.
CPT (Cost Per Task) offers use screenshot verification. Send visitors to the returned offer link for instructions and My Tasks. Each task pays after approval; the events list shows the publisher rewards. Lockers unlock only after every required task is confirmed.
Folosiți același subid sau ID de publicitate la revenirea la o ofertă cu evenimente. Păstrăm clicul inițial și termenul de 30 de zile. Redeschiderea ofertei nu o repornește. Linkurile directe fără ID folosesc un cookie; schimbarea browserului sau domeniului de urmărire ori ștergerea cookie-urilor poate pierde identitatea.
Use lead_id to credit each reward once. Event callbacks and conversion or reversal records include event_key and event_name. A later event has a new lead_id even when it belongs to the same offer and user.

Note despre API-ul de Oferte

Ofertele CPC și recompensele pentru clicuri boost prin API sunt disponibile numai membrilor CPAlead Premium care au plătit taxa de 100 $ și au accesul CPC API activat.
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.
Folosiți linkul exact returnat de API. Nu reconstruiți linkurile de urmărire CPAlead din ID-urile ofertelor în propriul sistem.
Clicurile boost eligibile pe oferte CPA, CPI sau CPE plătesc 0,10 $ pentru vizitatorii din SUA și 0,07 $ pentru vizitatorii din alte țări. Trebuie să mai existe clicuri boost disponibile și se aplică limitele obișnuite de eligibilitate a clicurilor.
Pentru ofertele CPC native, cpc_reward_type este native, iar amount reprezintă plata pe clic. Pentru ofertele boost, cpc_reward_type este boost_click, iar amount rămâne plata pe conversie. boost_click_balance arată numărul de clicuri boost rămase. API-ul returnează cpc_payout_us, cpc_payout_not_us sau ambele, în funcție de țările vizate de ofertă. Aceste recompense pentru clicuri sunt plătite numai editorului și nu trimit postbackuri către editor sau deblochează conținut printr-un postback.

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	În mod implicit, acest API returnează oferte CPA, CPI, CPE și CPT. Ofertele CPC native și recompensele pentru clicuri boost necesită calitatea de membru CPAlead Premium plătită și acces CPC API activat. Puteți solicita tipuri de plată separate 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	Returnați doar câmpurile ofertei de care aveți nevoie. Folosiți o listă separată prin virgulă, de exemplu `&fields=id,title,link,amount,offer_rank` Available fields: `id, title, description, long_description, conversion, device, daily_cap, is_fast_pay, review_period_hours, payment_terms_label, payment_terms_description, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country, events, conversion_mode, verification_method, cpc_reward_type, cpc_payout_us, cpc_payout_not_us, boost_click_balance` Use "description" for the short offer description. Use "long_description" when you want the longer marketplace description.
include_long_description	Set this to 0 or false to leave long_description out of the default Offers API response. If your fields list includes long_description, it will still be returned. `&include_long_description=0`
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	SubID tracking lets you pass extra data into CPAlead tracking links. CPAlead stores the value with clicks and conversions and returns it in publisher postbacks when available. If you do not pass subid, CPAlead will not add one automatically. Use a user ID, wallet ID, or click reference when you need to credit a specific visitor. You can also use a shared value for a page, site, sub-affiliate, keyword, or traffic source, but shared values are for reporting and segmentation and cannot identify one visitor for rewards. 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,
    "cpc_eligibility": {
        "access_enabled": false,
        "status": "not_enabled",
        "native_cpc_available": false,
        "boost_click_rewards_available": false
    },
    "offers": [
        {
            "id": 999001,
            "title": "QuizBlitz Pro",
            "description": "Test your knowledge and win rewards!",
            "long_description": "Play QuizBlitz Pro, answer trivia questions, and complete the required level to earn your reward.",
            "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",
            "conversion_mode": "single",
            "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
            },
            "events": [
                {
                    "key": "event_1",
                    "name": "Event 1",
                    "description": "Install and open the app.",
                    "amount": 0.7,
                    "payout_currency": "USD"
                },
                {
                    "key": "event_2",
                    "name": "Event 2",
                    "description": "Reach level 5.",
                    "amount": 1.2,
                    "payout_currency": "USD"
                }
            ]
        },
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "long_description": "Install PhotoMaster Lite, try the editing tools, and keep the app installed for the required period.",
            "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",
            "conversion_mode": "single",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": []
        }
    ]
}

Exemplu de răspuns: HTTP 403

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>

Exemplu de răspuns cu clicuri boost

Răspuns ilustrativ pentru un membru Premium care a plătit și are acces CPC API. Această ofertă CPI vizează SUA și Canada, deci sunt afișate ambele câmpuri de plată boost. amount este plata pe conversie; câmpurile CPC arată recompensele posibile pe clic.

{
    "status": "success",
    "number_offers": 1,
    "country": "US",
    "devices": null,
    "cpc_eligibility": {
        "access_enabled": true,
        "status": "eligible",
        "native_cpc_available": true,
        "boost_click_rewards_available": true
    },
    "offers": [
        {
            "id": 999002,
            "title": "PhotoMaster Lite",
            "description": "Edit photos with one tap.",
            "long_description": "Install PhotoMaster Lite, try the editing tools, and keep the app installed for the required period.",
            "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",
            "conversion_mode": "single",
            "countries": [
                "US",
                "CA"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": [],
            "cpc_reward_type": "boost_click",
            "boost_click_balance": 250,
            "cpc_payout_us": 0.1,
            "cpc_payout_not_us": 0.07
        }
    ]
}

API Conversii

Conversions și Reversals folosesc aceeași limită de cereri.
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

Dacă o cerere API returnează HTTP 429, așteptați numărul de secunde din Retry-After înainte de a reîncerca. Verificați X-RateLimit-Limit și X-RateLimit-Remaining și măriți întârzierea după eșecuri repetate.

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

Conversions și Reversals folosesc aceeași limită de cereri.
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