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

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 ng Mga Alok

Nagbabalik ng listahang JSON ng mga available na alok. Maaaring mauna ang mga itinatampok na alok. Pagkatapos niyan, mauna ang mga halagang mas mababa ang offer_rank.

Pagraranggo & Mga Payout Batay sa Bansa

Bawat alok ay may kasamang offer_rank kung saan ang 1 ang pinakamataas na naka-ranggo na alok. Maaaring mauna ang mga itinatampok na alok. Pagkatapos niyan, ang mga resulta ay mananatili sa pagkakasunod-sunod ng offer_rank mula sa mababa hanggang mataas.
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".

Mga Tala sa API ng Alok

Hindi nagbabalik ng mga alok ng CPC ang API na ito.
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.

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	Hindi nagbabalik ang API na ito ng mga alok ng CPC. Bilang default, nagbabalik ito ng mga alok na CPA, CPI, at CPE. Maaari ka ring humiling ng CPR gamit ang isang listahang pinaghiwalay 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	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 (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	Ang pagsubaybay sa SubID ay nagbibigay-daan sa iyo na magsumite ng dagdag na datos kapag nag-click ang isang gumagamit sa iyong mga link ng affiliate sa pamamagitan ng pagpasa ng tag sa dulo ng iyong mga link ng affiliate, awtomatikong pupunan ng parameter na ito ang subid sa iyong tracking link. Maaari mong gamitin ang mga SubID upang pangkatin ang mga lead, i-optimize ang mga kampanya, at pagandahin ang mga pag-convert, narito ang ilang halimbawa: Mga ID ng Sub-Affiliate, Mga Pinagmulan (Organic, PPC, Email atbp), Mga Keyword, Mga Lokasyon, atbp... 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!",
            "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
        }
    ]
}

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>

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

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