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

Bạn muốn quản lý chiến dịch của nhà quảng cáo?

Publisher API trên trang này dùng để lấy ưu đãi và báo cáo dành cho nhà xuất bản. Nhà quảng cáo có thể dùng Campaign API riêng để xác thực, tạo, chỉnh sửa, bắt đầu và tạm dừng các chiến dịch tự phục vụ, kể cả với sự hỗ trợ của một tác nhân AI.

Đọc hướng dẫn 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: Chỉ dành cho Thành viên CPAlead Premium đã trả phí
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

Thu nhập từ CPC và lượt nhấp boost yêu cầu tư cách thành viên CPAlead Premium đã trả phí và quyền truy cập CPC API được bật. Các ưu đãi có boost vẫn giữ thứ hạng thông thường.

OpenAPI File

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

API Ưu đãi

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

Quyền truy cập CPC API của bạn

Đăng nhập để xem quyền truy cập

Vì sao phần thưởng cho lượt nhấp có thể tạm dừng

Ưu đãi CPC và phần thưởng cho lượt nhấp boost có thể bị giới hạn tạm thời nếu lưu lượng của bạn tạo ra nhiều lượt nhấp liên tiếp nhưng không có đủ chuyển đổi CPA hoặc CPI đủ điều kiện. Điều này giúp bảo vệ nhà quảng cáo khỏi bot và lưu lượng không hợp lệ.

Ưu đãi CPC gốc và các trường phần thưởng boost-click được ẩn khỏi nguồn cấp API trong thời gian tạm dừng này. Các chuyển đổi CPA hoặc CPI đủ điều kiện sẽ tự động gỡ bỏ việc tạm dừng. Các ưu đãi chuyển đổi đủ điều kiện vẫn khả dụng. Làm mới toàn bộ nguồn cấp ưu đãi để cập nhật tình trạng khả dụng; các điều kiện khác của lượt nhấp vẫn được áp dụng.

Trạng thái đủ điều kiện CPC

Mọi phản hồi ưu đãi thành công đều có cpc_eligibility, kể cả khi không có ưu đãi phù hợp hoặc khi dùng fields. access_enabled cho biết quyền của tài khoản. status là not_enabled, eligible, conversion_limited hoặc unavailable. native_cpc_available và boost_click_rewards_available cho biết các phần thưởng này hiện có khả dụng cho tài khoản hay không.

So sánh các giá trị này mỗi lần đồng bộ. Khi chúng thay đổi, làm mới toàn bộ nguồn cấp mà không dùng updated_since và thay thế danh sách đã lưu. Trạng thái không đảm bảo phần thưởng cho mọi lượt nhấp; các kiểm tra lượt nhấp khác vẫn được áp dụng.

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.
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.
Dùng cùng subid hoặc ID quảng cáo khi quay lại ưu đãi có sự kiện. Chúng tôi giữ lần nhấp đầu tiên và hạn 30 ngày của lần nhấp đó. Mở lại không bắt đầu lại ưu đãi. Liên kết trực tiếp không có ID dùng cookie trình duyệt; đổi trình duyệt, xóa cookie hoặc đổi tên miền theo dõi có thể làm mất danh tính này.
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.

Ghi chú API Ưu đãi

Ưu đãi CPC và phần thưởng cho lượt nhấp boost qua API chỉ dành cho Thành viên CPAlead Premium đã trả phí thành viên $100 và được bật quyền truy cập CPC API.
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 đúng liên kết do API trả về. Không tự tạo lại liên kết theo dõi CPAlead từ ID ưu đãi trong hệ thống của bạn.
Lượt nhấp boost đủ điều kiện trên các ưu đãi CPA, CPI hoặc CPE được trả $0.10 cho khách truy cập từ Mỹ và $0.07 cho khách truy cập từ các quốc gia khác. Ưu đãi phải còn lượt nhấp boost và các giới hạn thông thường về điều kiện nhận thưởng vẫn áp dụng.
Với ưu đãi CPC gốc, cpc_reward_type là native và amount là khoản thanh toán cho mỗi lượt nhấp. Với ưu đãi có boost, cpc_reward_type là boost_click và amount vẫn là khoản thanh toán cho chuyển đổi. boost_click_balance cho biết số lượt nhấp boost còn lại. API trả về cpc_payout_us, cpc_payout_not_us hoặc cả hai, tùy theo các quốc gia mà ưu đãi nhắm đến. Phần thưởng cho lượt nhấp này chỉ được trả cho nhà xuất bản, không gửi postback cho nhà xuất bản và không mở khóa nội dung qua postback.

Đ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	Theo mặc định, API này trả về các ưu đãi CPA, CPI, CPE và CPT. Ưu đãi CPC gốc và phần thưởng cho lượt nhấp boost yêu cầu tư cách thành viên CPAlead Premium đã trả phí và quyền truy cập CPC API được bật. Bạn có thể yêu cầu các loại thanh toán bằng danh sách phân tá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	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, 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	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,
    "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": []
        }
    ]
}

Ví dụ phản hồi: HTTP 403

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>

Ví dụ phản hồi có lượt nhấp boost

Phản hồi minh họa cho Thành viên Premium đã trả phí và có quyền truy cập CPC API. Ưu đãi CPI này nhắm đến Mỹ và Canada nên hiển thị cả hai trường thanh toán boost. amount là khoản thanh toán cho chuyển đổi; các trường CPC cho biết phần thưởng có thể nhận từ lượt nhấp.

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

Conversions và Reversals dùng chung giới hạn yêu cầu.
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

Nếu yêu cầu API trả về HTTP 429, hãy chờ số giây trong Retry-After trước khi thử lại. Kiểm tra X-RateLimit-Limit và X-RateLimit-Remaining, đồng thời tăng thời gian chờ nếu liên tục thất bạ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

Conversions và Reversals dùng chung giới hạn yêu cầu.
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