Dokumentasyon ng API ng Naglalathala ng CPAlead

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

Most accounts do not receive 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 .

01

API ng Mga Alok

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

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.

Mga Tala sa API ng Alok

Most accounts do not receive native CPC offers. If CPAlead enables CPC API access for your account, native CPC offers can appear and the amount field is your publisher payout.
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.
Ang paggamit ng eksaktong link na ibinalik ng API ay pinananatili ang pinakamahusay na pag-uugnay. Kung i-save mo o buuin muli ang mga link sa iyong sariling sistema, gumagana pa rin ang mga click.
If CPAlead enables CPC API access for your publisher account, native CPC offers can appear in the Offers API. Boosted CPA, CPI, or CPE offers can also include publisher-only CPC rewards.
For native CPC offers, use the amount field. For boosted offers, boost_click_balance shows the remaining boost clicks. The API shows cpc_reward_type, cpc_payout_us, cpc_payout_not_us, or both payout fields based on the offer target countries. CPC API rewards do not fire publisher postbacks.

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	By default this API returns CPA, CPI, and CPE offers. Publishers with CPC API access can also receive native CPC offers and boosted offers with CPC rewards. You can request payout types with a comma-separated list, for example `&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, link, preview_link, amount, payout_currency, payout_type, countries, epc, creatives, offer_rank, payouts_per_country, events, 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,
    "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",
            "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",
            "countries": [
                "US"
            ],
            "epc": 1.1,
            "creatives": {
                "url": "https://{assets_domain}/images/photomaster.png"
            },
            "offer_rank": 12,
            "events": []
        }
    ]
}

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>

02

API ng Mga Pag-convert

Limitasyon: 1 request bawat minuto
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

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

03

API ng Mga Pagbabalik

Limitasyon: 1 request bawat minuto
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

Publisher API Documentation

What this API is designed for

API ng Mga Alok

API ng Mga Pag-convert

API ng Mga Pagbabalik