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 sa mga Alayon API sa mga Konbersiyon API sa mga Pagbalik

Gusto nimong pagdumala ang mga kampanya sa advertiser?

Ang Publisher API niini nga panid alang sa pagkuha sa mga offer ug publisher reporting. Mahimong gamiton sa mga advertiser ang lahi nga Campaign API aron ma-validate, makahimo, maka-edit, makasugod, ug makapahunong sa self-serve nga mga kampanya, lakip ang tabang sa AI agent.

Basaha ang giya sa Advertiser Campaign API

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: Alang lamang sa bayad nga CPAlead Premium Members
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

Ang kita gikan sa CPC ug boost clicks nanginahanglan og bayad nga CPAlead Premium membership ug naka-enable nga CPC API access. Ang boosted offers nagpabilin sa ilang normal nga ranggo.

OpenAPI File

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

API sa mga Alayon

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

Ang imong CPC API access

Pag-sign in aron makita ang imong access

Nganong mahimong temporaryong mahunong ang mga click reward

Mahimong temporaryong limitahan ang CPC offers ug boost-click rewards kon ang imong traffic makahimo og balikbalik nga mga click nga walay igo nga kwalipikadong CPA o CPI conversions. Kini makatabang sa pagpanalipod sa mga advertiser gikan sa mga bot ug dili balidong traffic.

Ang native CPC offers ug mga field sa boost-click reward gitago sa imong API feed samtang gihunong ang mga click reward. Awtomatikong matapos ang paghunong kon adunay kwalipikadong CPA o CPI conversions. Magamit gihapon ang kwalipikadong conversion offers. I-refresh ang tibuok offer feed aron ma-update ang mga available nga offer; magpadayon gihapon ang ubang pagsusi sa kwalipikasyon sa click.

CPC eligibility status

Ang matag malampusong offers response adunay cpc_eligibility, bisan walay angay nga offer o gigamit ang fields. Ang access_enabled nagpakita sa permiso sa imong account. Ang status mahimong not_enabled, eligible, conversion_limited, o unavailable. Ang native_cpc_available ug boost_click_rewards_available nagpakita kon magamit ba karon ang maong rewards sa imong account.

Itandi kini nga mga value matag sync. Kon mausab kini, i-refresh ang tibuok feed nga walay updated_since ug ilisi ang imong gitipig nga offer list. Ang status dili garantiya nga matag click adunay reward; magpadayon ang ubang pagsusi sa click.

Ranggo & Mga Bayad sa Nasod

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
Ang uban nga mga alayon lain-lain ang bayad depende sa nasod. Kung ang usa ka alayon naglakip og lista sa "payouts_per_country", gamita ang bayad nga mohaom sa duha ka-titik nga code sa nasod sa gamiton (pananglitan, US, CA, GB). Kung ang ilang nasod wala sa lista, gamita ang default nga bayad nga ipakita sa "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.
Gamita ang parehas nga subid o advertising ID sa pagbalik sa event offer. Gipabilin ang unang click ug ang 30 ka adlaw nga takdang panahon. Ang pag-abli pag-usab dili magsugod pag-usab. Ang direktang link nga walay ID naggamit og browser cookie; mahimong mawala ang identidad kung mag-ilis og browser o tracking domain, o magpapas og cookies.
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.

Mga Pahimangno sa API sa Alayon

Ang CPC offers ug boost-click rewards pinaagi sa API alang lamang sa mga CPAlead Premium Member nga mibayad sa $100 nga membership fee ug adunay naka-enable nga CPC API access.
Kung ang usa ka alayon adunay boost clicks, magpabilin kini sa iyang normal nga ranggo. Dili kini ibutang sa taas lang kay naa kini boost clicks.
Gamita ang eksaktong link nga gibalik sa API. Ayaw paghimo pag-usab sa CPAlead tracking links gikan sa offer IDs sa imong kaugalingong sistema.
Ang kwalipikadong boost clicks sa CPA, CPI, o CPE offers mobayad og $0.10 alang sa mga bisita gikan sa US ug $0.07 alang sa mga bisita gikan sa ubang nasod. Kinahanglan adunay nahibiling boost clicks ug magamit gihapon ang normal nga mga limitasyon sa kwalipikasyon sa click.
Alang sa native CPC offers, native ang cpc_reward_type ug ang amount mao ang bayad nimo matag click. Alang sa boosted offers, boost_click ang cpc_reward_type ug ang amount nagpabilin nga bayad sa conversion. Ang boost_click_balance nagpakita sa nahibiling boost clicks. Ang API nagbalik sa cpc_payout_us, cpc_payout_not_us, o pareho, sumala sa mga nasod nga gitarget sa offer. Kining mga click reward ibayad lamang sa publisher ug dili mopadala og publisher postbacks o moabli og content pinaagi sa postback.

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
country	Ipakita lang ang mga alayon gikan sa nasod, isulod ang duha ka-titik nga ISO nga code sa nasod Gamita `country=user` aron makuha ang mga alayon para sa nasod sa gamiton nga tiggamit awtomatiko
limit	Limitahi ang gidaghanon sa mga alayon nga mabalik. Makatabang kini nga paspason ang imong mga tawag sa API. Ang default mao ang 2500 ug ang pinakataas mao ang 5000.
type	Sa default, kining API nagbalik og mga CPA, CPI, CPE, ug CPT nga offer. Ang native CPC offers ug boost-click rewards nanginahanglan og bayad nga CPAlead Premium membership ug naka-enable nga CPC API access. Mahimo kang mangayo og mga matang sa payout nga gibulag sa kuwit, pananglitan `&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	Ibalik lang ang mga field sa alayon nga imong gikinahanglan. Gamita ang lista nga gipagkamao sa komo, pananglitan `&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 (tinuod\|sayop). Gamita ang tinuod kung gusto mo usab ang mga alayon nga gi-markahan para sa offerwall. Ang mga alayon nga CPC magpabilin nga wala ug ang mga alayon nga boost-click magpadayon sa ilang normal nga ranggo.
device	Gamita kini kung dili ka gamita og awtomatikong pag-target sa device. Sa default, ang API makapabalik sa tanan nga klase sa device. Gamita kini nga field aron sa piho lang nga mga klase sa device ang mabalik. Magamit nga mga balor: ios, android, mobile, ug desktop. Ang Device pwede usab nga lista nga gipagkamao sa komo, pananglitan: `&device=ios,android,mobile,desktop` Para makakuha lang og mga alayon nga CPI / CPE (nga nanginahanglan lang og pag-instalar alang sa konbersiyon - gamita device=ios,android Gamita `device=user` aron makuha ang mga alayon para sa device sa gamiton nga tiggamit awtomatiko
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. Ikaduhang variable sa subid alang sa dugang nga datos Ikatulong variable sa subid alang sa dugang nga datos
gaid / idfa	Kung naa kay Google Advertising ID (GAID) para sa mobile, gamita kini nga variable aron awtomatikong mapuno ang gaid sa imong tracking link Kung naa kay Apple Identifier For Advertisers (IDFA) para sa mobile, gamita kini nga variable aron awtomatikong mapuno ang idfa sa imong tracking link
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

{
    "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": []
        }
    ]
}

Pananglitan sa tubag: HTTP 403

Pananglitan sa code

<!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>

Pananglitan sa response nga adunay boost clicks

Pananglitan nga response alang sa bayad nga Premium Member nga adunay CPC API access. Kining CPI offer nagtumong sa US ug Canada, busa gipakita ang duha ka boost payout field. Ang amount mao ang bayad sa conversion; ang mga CPC field nagpakita sa posibleng mga click reward.

{
    "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 sa mga Konbersiyon

Ang Conversions ug Reversals nag-ambit sa limitasyon sa mga hangyo.
Ang API sa Konbersiyon naghatag kanimo og kapabilidad nga iping ang CPAlead aron mosusi sa mga konbersiyon, mapuslanon sa paghimo og mga custom nga aplikasyon. Ihatag ang subid isip subid o IP address, o "user" aron ang atong system magamit ang IP address sa kliyente nga mitawag niining script (mapuslanon para sa mga tawag sa JSONP)
Para sa serbisyo sa konbersiyon nga tipo push (Server-to-Server Postback), tan-awa ang among Dokumentasyon sa Postback

Kon ang hangyo sa API motubag og HTTP 429, hulata ang gidaghanon sa segundos sa Retry-After una mosulay pag-usab. Susiha ang X-RateLimit-Limit ug X-RateLimit-Remaining, ug dugangi ang paghulat kon balik-balik ang kapakyasan.

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Gikinahanglan. Tan-awa ang konbersiyon pinaagi sa subid, ihatag ang subid o IP address sa gamiton, ihatag ang "user" aron magamit ang IP address sa kliyente nga mitawag niining script (mapuslanon para sa mga tawag sa JSONP)
offer_id	Opsyonal. Susiha lang ang konbersiyon para niining ID sa alayon (kampanya)
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag

API sa mga Pagbalik

Ang Conversions ug Reversals nag-ambit sa limitasyon sa mga hangyo.
Gamita kini nga API aron ma-download ang imong lista sa daotang mga lead taliwala sa duha ka mga petsa. Mapuslanon ni sa paghan-ay sa daotang trapiko

Dulnganan

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

Magamit nga mga parameter sa pangutana sa HTTP

Parameter sa HTTP	Pagpasabot
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Petsa sa sinugdanan nga gamiton sa pagkuha sa daotang mga lead. Porma: yyyy-mm-dd
end_date	Petsa sa katapusan nga gamiton sa pagkuha sa daotang mga lead. Hangtod lang sa usa ka bulan ang pwede makuha sa usa ka panahon
format / callback	Porma nga JSON o JSONP. Ang JSON mao ang default Pangalan sa callback function sa JSONP. Gigamit lang para sa pormat sa JSONP. Kung mogamit og jQuery getJSON, gamita ang callback=? ug ang jQuery awtomatikong magpuno sa ngalan sa function para kanimo. Tan-awa ang pananglitan sa JSONP

Pananglitan sa tubag