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 Ưu đãi API Chuyển đổi API Hoàn tiền

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 Ưu đãi

Trả về một danh sách JSON các ưu đãi có sẵn. Các ưu đãi nổi bật có thể hiển thị trước. Sau đó, giá trị offer_rank thấp hơn sẽ hiển thị trước.

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

Mỗi ưu đãi bao gồm một offer_rank mà 1 là ưu đãi có xếp hạng cao nhất. Các ưu đãi nổi bật có thể xuất hiện trước. Sau đó, kết quả sẽ giữ thứ tự offer_rank từ thấp đến cao.
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".

Ghi chú API Ưu đãi

Các ưu đãi CPC không được trả về bởi API này.
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.

Đ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	API này không trả về ưu đãi CPC. Mặc định nó trả về CPA, CPI, và CPE. Bạn cũng có thể yêu cầu CPR bằng danh sách phân cách bằng dấu phẩy, ví dụ `&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	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	Theo dõi SubID cho phép bạn gửi dữ liệu bổ sung khi người dùng nhấp vào các liên kết liên kết tiếp thị của bạn bằng cách truyền một thẻ ở cuối liên kết liên kết tiếp thị của bạn, tham số này sẽ tự động điền subid vào liên kết theo dõi của bạn. Bạn có thể dùng SubID để phân đoạn khách hàng tiềm năng, tối ưu chiến dịch, và cải thiện chuyển đổi, dưới đây là một số ví dụ: ID phụ liên kết tiếp thị, Nguồn (Tự nhiên, PPC, Email, v.v.), Từ khóa, Vị trí, v.v... 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!",
            "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
        }
    ]
}

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>

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

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