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 ng Mga Alok API ng Mga Pag-convert API ng Mga Pagbabalik

Nais bang pamahalaan ang mga advertiser campaign?

Ang Publisher API sa pahinang ito ay para sa pagkuha ng mga offer at publisher reporting. Maaaring gamitin ng mga advertiser ang hiwalay na Campaign API upang i-validate, gumawa, mag-edit, magsimula, at mag-pause ng mga self-serve campaign, kasama ang tulong ng isang AI agent.

Basahin ang gabay 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: Para lamang sa mga bayad na CPAlead Premium Member
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

Kailangan ng bayad na CPAlead Premium membership at naka-enable na CPC API access para kumita sa CPC at boost clicks. Nananatili ang karaniwang ranggo ng mga boosted offer.

OpenAPI File

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

API ng Mga Alok

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

Ang iyong CPC API access

Mag-sign in para makita ang iyong access

Bakit maaaring huminto pansamantala ang mga click reward

Maaaring pansamantalang limitahan ang mga CPC offer at boost-click reward kung paulit-ulit ang mga click mula sa iyong traffic ngunit kulang ang mga kwalipikadong CPA o CPI conversion. Nakakatulong ito na protektahan ang mga advertiser mula sa mga bot at hindi wastong traffic.

Nakatago sa iyong API feed ang mga native CPC na alok at boost-click reward field habang nakahinto ang mga click reward. Awtomatikong inaalis ang paghinto kapag may mga kwalipikadong CPA o CPI conversion. Available pa rin ang mga kwalipikadong conversion na alok. I-refresh ang buong offer feed upang ma-update ang mga available na alok; kailangan pa ring pumasa ang mga click sa iba pang kondisyon.

CPC eligibility status

Bawat matagumpay na offers response ay may cpc_eligibility, kahit walang tumugmang alok o ginamit ang fields. Ipinapakita ng access_enabled ang pahintulot ng account mo. Ang status ay not_enabled, eligible, conversion_limited, o unavailable. Ipinapakita ng native_cpc_available at boost_click_rewards_available kung available ang mga reward na iyon sa account mo ngayon.

Ihambing ang mga value na ito sa bawat sync. Kapag nagbago ang mga ito, i-refresh ang buong feed nang walang updated_since at palitan ang naka-save na offer list. Hindi garantiya ng reward sa bawat click ang status; kailangan pa ring pumasa sa iba pang pagsusuri ng click.

Pagraranggo & Mga Payout Batay sa Bansa

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
Ang ilang mga alok ay nagbabayad ng magkakaibang halaga depende sa bansa. Kung ang isang alok ay may kasamang listahan ng "payouts_per_country", gamitin ang payout na tumutugma sa dalawang-titik na country code ng gumagamit (hal., US, CA, GB). Kung wala ang kanilang bansa sa listahan, gamitin ang default na payout na ipinapakita 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.
Gamitin ang parehong subid o advertising ID kapag bumalik sa event offer. Ginagamit muli ang orihinal na click at 30-araw na takdang panahon nito. Hindi ito nagsisimula muli sa pagbukas. Gumagamit ng browser cookie ang mga direktang link na walang ID; maaaring mawala ang pagkakakilanlan kapag nagpalit ng browser o tracking domain, o nag-clear ng 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 Tala sa API ng Alok

Ang mga CPC offer at boost-click reward sa API ay para lamang sa mga CPAlead Premium Member na nagbayad ng $100 membership fee at may naka-enable na CPC API access.
Kung may boost clicks ang isang alok, pinananatili pa rin nito ang normal na ranggo nito. Hindi ito inililipat sa tuktok dahil lamang may boost clicks ito.
Gamitin ang eksaktong link na ibinalik ng API. Huwag buuin muli ang mga CPAlead tracking link mula sa mga offer ID sa sarili mong system.
Ang mga kwalipikadong boost click sa mga alok na CPA, CPI, o CPE ay nagbabayad ng $0.10 para sa mga bisita mula sa US at $0.07 para sa mga bisita mula sa ibang bansa. Kailangan may natitirang boost clicks at sinusunod pa rin ang karaniwang mga limitasyon sa pagiging kwalipikado ng click.
Para sa mga native CPC offer, native ang cpc_reward_type at ang amount ang bayad mo sa bawat click. Para sa mga boosted offer, boost_click ang cpc_reward_type at ang amount ay nananatiling bayad sa conversion. Ipinapakita ng boost_click_balance ang natitirang boost clicks. Ibinabalik ng API ang cpc_payout_us, cpc_payout_not_us, o pareho, ayon sa mga bansang target ng alok. Sa publisher lamang ibinabayad ang mga click reward na ito. Hindi sila nagpapadala ng publisher postback o nagbubukas ng content sa pamamagitan ng postback.

Punto ng Wakas

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

Mga available na parameter ng HTTP query

Parameter ng HTTP	Paglalarawan
id	Required. Your publisher ID.
country	Ipakita lang ang mga alok mula sa bansa, magpasa ng dalawang-titik na ISO country code Gamitin `country=user` upang awtomatikong kumuha ng mga alok para sa bansa ng gumagamit
limit	Limitahan ang bilang ng mga alok na ibinabalik. Makakatulong ito na pabilisin ang iyong mga API call. Ang default ay 2500 at ang pinakamataas ay 5000.
type	Bilang default, nagbabalik ang API na ito ng mga alok na CPA, CPI, CPE, at CPT. Kailangan ng bayad na CPAlead Premium membership at naka-enable na CPC API access para sa mga native CPC offer at boost-click reward. Maaari kang humiling ng mga uri ng payout na pinaghihiwalay ng kuwit, halimbawa `&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 ng alok na kailangan mo. Gumamit ng listahang pinaghiwalay ng kuwit, halimbawa `&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 (true\|false). Gamitin ang true kung gusto mo rin ng mga alok na minarkahan para sa mga offerwall. Nanatiling hindi kasama ang mga alok ng CPC, at ang mga alok na boost-click ay pinananatili ang kanilang normal na ranggo.
device	Gamitin ito lamang kung hindi ka gumagamit ng awtomatikong pag-target ng device. Bilang default, maaaring ibalik ng API ang lahat ng uri ng device. Gamitin ang field na ito upang mabawi lang ang ilang tiyak na uri ng device. Mga available na halaga: ios, android, mobile, at desktop. Maaari ring ang Device ay isang listahang pinaghiwalay ng kuwit, halimbawa: `&device=ios,android,mobile,desktop` Para makakuha lamang ng mga alok na CPI / CPE (na nangangailangan lamang ng pag-install para sa pag-convert - gamitin device=ios,android Gamitin `device=user` upang awtomatikong kumuha ng mga alok para sa device ng gumagamit
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. Isang ikatlong variable ng subid para sa dagdag na datos Isang ikatlong variable ng subid para sa dagdag na datos
gaid / idfa	Kung mayroon kang Google Advertising ID (GAID) para sa mobile, gamitin ang variable na ito upang awtomatikong punan ang gaid sa iyong tracking link Kung mayroon kang Apple Identifier For Advertisers (IDFA) para sa mobile, gamitin ang variable na ito upang awtomatikong punan ang idfa sa iyong tracking link
format / callback	Format na JSON o JSONP. JSON ang default Pangalan ng function ng callback ng JSONP. Ginagamit lamang para sa format na JSONP. Kung gagamit ng jQuery getJSON, gamitin ang callback=? at awtomatikong pupunan ng jQuery ang pangalan ng function para sa iyo. Tingnan ang halimbawa ng JSONP

Halimbawa ng tugon

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

Halimbawa ng tugon: HTTP 403

Halimbawa ng kodigo

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

Halimbawa ng response na may boost clicks

Halimbawang response para sa bayad na Premium Member na may CPC API access. Target ng CPI offer na ito ang US at Canada, kaya ipinapakita ang dalawang boost payout field. Ang amount ay bayad sa conversion; ipinapakita ng mga CPC field ang 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 ng Mga Pag-convert

Iisa ang limitasyon ng mga request sa Conversions at Reversals.
Pinapayagan ka ng Conversion API na i-ping ang CPAlead upang subukan ang mga pag-convert, na kapaki-pakinabang sa pagbuo ng mga pasadyang app. Ipasa ang subid bilang subid o IP address, o "user" upang gamitin ng aming sistema ang IP address ng kliyenteng tumatawag sa script na ito (kapaki-pakinabang para sa mga JSONP call)
Para sa serbisyong pag-convert na uri ng push (Server-to-Server Postback), tingnan ang aming Dokumentasyon ng Postback

Kapag nagbalik ng HTTP 429 ang isang API request, hintayin ang bilang ng segundo sa Retry-After bago subukang muli. Suriin ang X-RateLimit-Limit at X-RateLimit-Remaining, at dagdagan ang paghihintay kapag paulit-ulit na nabibigo.

Punto ng Wakas

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

Mga available na parameter ng HTTP query

Parameter ng HTTP	Paglalarawan
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Kinakailangan. Hanapin ang pag-convert batay sa subid, ipasa ang subid o IP address ng gumagamit, ipasa ang "user" upang gamitin ang IP address ng kliyenteng tumatawag sa script na ito (kapaki-pakinabang para sa mga JSONP call)
offer_id	Opsyonal. Susuriin lamang ang pag-convert para sa ID ng alok (kampanya) na ito
format / callback	Format na JSON o JSONP. JSON ang default Pangalan ng function ng callback ng JSONP. Ginagamit lamang para sa format na JSONP. Kung gagamit ng jQuery getJSON, gamitin ang callback=? at awtomatikong pupunan ng jQuery ang pangalan ng function para sa iyo. Tingnan ang halimbawa ng JSONP

Halimbawa ng tugon

API ng Mga Pagbabalik

Iisa ang limitasyon ng mga request sa Conversions at Reversals.
Gamitin ang API na ito upang i-download ang iyong listahan ng mga masasamang lead sa pagitan ng dalawang petsa. Kapaki-pakinabang ito para sa pag-aayos ng masamang trapiko

Punto ng Wakas

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

Mga available na parameter ng HTTP query

Parameter ng HTTP	Paglalarawan
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Petsa ng simula na gagamitin kapag kukuhanin ang mga masasamang lead. Format: yyyy-mm-dd
end_date	Petsa ng wakas na gagamitin kapag kukuhanin ang mga masasamang lead. Pinakamataas na isang buwan ang maaaring kukuhanin sa isang beses
format / callback	Format na JSON o JSONP. JSON ang default Pangalan ng function ng callback ng JSONP. Ginagamit lamang para sa format na JSONP. Kung gagamit ng jQuery getJSON, gamitin ang callback=? at awtomatikong pupunan ng jQuery ang pangalan ng function para sa iyo. Tingnan ang halimbawa ng JSONP

Halimbawa ng tugon