Tài liệu API Nhà xuất bản 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 Ưu đãi

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

Xếp hạng & Thanh toán theo quốc gia

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
Một số ưu đãi trả khác nhau tùy theo quốc gia. Nếu một ưu đãi có danh sách "payouts_per_country", hãy dùng mức chi trả khớp với mã quốc gia hai chữ cái của người dùng (ví dụ, US, CA, GB). Nếu quốc gia của họ không có trong danh sách, hãy dùng mức chi trả mặc định được hiển thị trong "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.

Ghi chú API Ưu đãi

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.
Nếu một ưu đãi có boost clicks, nó vẫn giữ hạng bình thường. Nó không được đưa lên đầu chỉ vì có boost clicks.
Sử dụng liên kết chính xác được API trả về sẽ giữ phân bổ tốt nhất. Nếu bạn lưu hoặc tạo lại liên kết trong hệ thống của bạn, các lần nhấp vẫn hoạt động.
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.

Điểm cuối

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

Các tham số truy vấn HTTP có sẵn

Tham số HTTP	Mô tả
id	Required. Your publisher ID.
country	Chỉ hiển thị ưu đãi từ quốc gia, truyền vào mã quốc gia ISO hai chữ cái Sử dụng `country=user` để lấy ưu đãi cho quốc gia của người dùng tự động
limit	Giới hạn số lượng ưu đãi được trả về. Điều này có thể giúp các lần gọi API của bạn nhanh hơn. Mặc định là 2500 và tối đa là 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	Chỉ trả về các trường ưu đãi bạn cần. Dùng danh sách phân cách bằng dấu phẩy, ví dụ `&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	Giá trị Boolean (true\|false). Dùng true nếu bạn cũng muốn các ưu đãi được đánh dấu cho offerwall. Ưu đãi CPC vẫn không được đưa vào, và các ưu đãi boost-click giữ nguyên hạng bình thường.
device	Chỉ dùng trường này nếu bạn không sử dụng nhắm mục tiêu thiết bị tự động. Mặc định, API có thể trả về tất cả các loại thiết bị. Dùng trường này để chỉ trả về một số loại thiết bị cụ thể. Các giá trị có sẵn: ios, android, mobile, và desktop. Thiết bị cũng có thể là danh sách phân cách bằng dấu phẩy, ví dụ: `&device=ios,android,mobile,desktop` Để chỉ lấy ưu đãi CPI / CPE (chỉ yêu cầu cài đặt để chuyển đổi - dùng device=ios,android Sử dụng `device=user` để lấy ưu đãi cho thiết bị của người dùng tự động
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. Một biến subid thứ hai để thêm dữ liệu Một biến subid thứ ba để thêm dữ liệu
gaid / idfa	Nếu bạn có Google Advertising ID (GAID) cho di động, hãy dùng biến này để tự động điền gaid vào liên kết theo dõi của bạn Nếu bạn có Apple Identifier For Advertisers (IDFA) cho di động, hãy dùng biến này để tự động điền idfa vào liên kết theo dõi của bạn
format / callback	Định dạng JSON hoặc JSONP. JSON là mặc định Tên hàm gọi lại JSONP. Chỉ dùng cho định dạng JSONP. Nếu dùng jQuery getJSON, hãy dùng callback=? và jQuery sẽ tự động điền tên hàm cho bạn. Xem ví dụ JSONP

Ví dụ phản hồi

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

Ví dụ mã

<!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 Chuyển đổi

Giới hạn: 1 yêu cầu mỗi phút
API Chuyển đổi cho phép bạn ping CPAlead để kiểm tra chuyển đổi, hữu ích cho việc tạo ứng dụng tùy chỉnh. Truyền subid vào dạng subid hoặc địa chỉ IP, hoặc "user" để hệ thống của chúng tôi sử dụng địa chỉ IP của máy khách đang gọi script này (hữu ích cho các lần gọi JSONP)
Đối với dịch vụ chuyển đổi kiểu đẩy (Gửi ngược máy chủ sang máy chủ), xem Tài liệu Gửi ngược của chúng tôi

Điểm cuối

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

Các tham số truy vấn HTTP có sẵn

Tham số HTTP	Mô tả
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Bắt buộc. Tra cứu chuyển đổi dựa trên subid, truyền subid hoặc địa chỉ IP của người dùng, truyền "user" để dùng địa chỉ IP của máy khách đang gọi script này (hữu ích cho các lần gọi JSONP)
offer_id	Tùy chọn. Sẽ chỉ kiểm tra chuyển đổi cho id ưu đãi (chiến dịch) này
format / callback	Định dạng JSON hoặc JSONP. JSON là mặc định Tên hàm gọi lại JSONP. Chỉ dùng cho định dạng JSONP. Nếu dùng jQuery getJSON, hãy dùng callback=? và jQuery sẽ tự động điền tên hàm cho bạn. Xem ví dụ JSONP

Ví dụ phản hồi

03

API Hoàn tiền

Giới hạn: 1 yêu cầu mỗi phút
Dùng API này để tải xuống danh sách khách hàng tiềm năng xấu của bạn giữa hai ngày. Hữu ích để sàng lọc lưu lượng xấu

Điểm cuối

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

Các tham số truy vấn HTTP có sẵn

Tham số HTTP	Mô tả
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Ngày bắt đầu dùng khi lấy khách hàng tiềm năng xấu. Định dạng: yyyy-mm-dd
end_date	Ngày kết thúc dùng khi lấy khách hàng tiềm năng xấu. Tối đa chỉ có thể lấy trong một tháng mỗi lần
format / callback	Định dạng JSON hoặc JSONP. JSON là mặc định Tên hàm gọi lại JSONP. Chỉ dùng cho định dạng JSONP. Nếu dùng jQuery getJSON, hãy dùng callback=? và jQuery sẽ tự động điền tên hàm cho bạn. Xem ví dụ JSONP

Ví dụ phản hồi

Publisher API Documentation

What this API is designed for

API Ưu đãi

API Chuyển đổi

API Hoàn tiền