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.

বিজ্ঞাপনদাতার ক্যাম্পেইন পরিচালনা করতে চান?

এই পাতার Publisher API অফার সংগ্রহ এবং পাবলিশার রিপোর্টিংয়ের জন্য। বিজ্ঞাপনদাতারা আলাদা Campaign API ব্যবহার করে self-serve ক্যাম্পেইন যাচাই, তৈরি, সম্পাদনা, শুরু ও বিরতি দিতে পারেন, এমনকি AI agent-এর সহায়তায়ও।

Advertiser Campaign API নির্দেশিকা পড়ুন

This page is public. Replace placeholder values like {PUBLISHER_ID} and {API_KEY} with your own values after you sign in.

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

CPC ও বুস্ট ক্লিক থেকে আয়ের জন্য অর্থ দিয়ে নেওয়া CPAlead Premium সদস্যপদ এবং চালু CPC API অ্যাক্সেস প্রয়োজন। বুস্ট করা অফার তাদের স্বাভাবিক র‍্যাঙ্কেই থাকে।

OpenAPI File

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

01

অফার এপিআই

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

কেন ক্লিকের পুরস্কার সাময়িকভাবে বন্ধ হতে পারে

আপনার ট্রাফিক থেকে বারবার ক্লিক এলেও যথেষ্ট যোগ্য CPA বা CPI কনভার্শন না হলে CPC অফার ও বুস্ট ক্লিকের পুরস্কার সাময়িকভাবে সীমিত হতে পারে। এটি বিজ্ঞাপনদাতাদের বট ও অবৈধ ট্রাফিক থেকে রক্ষা করতে সাহায্য করে।

এই বিরতির সময় নেটিভ CPC অফার ও বুস্ট-ক্লিক পুরস্কারের ফিল্ড আপনার API ফিড থেকে লুকানো থাকে। যোগ্য CPA বা CPI কনভার্শন হলে বিরতি স্বয়ংক্রিয়ভাবে উঠে যায়। যোগ্য কনভার্শন অফার পাওয়া যায়। উপলব্ধ অফার আপডেট করতে পুরো অফার ফিড রিফ্রেশ করুন; ক্লিকের যোগ্যতার অন্যান্য যাচাই প্রযোজ্য থাকে।

CPC যোগ্যতার অবস্থা

প্রতিটি সফল অফার রেসপন্সে cpc_eligibility থাকে, কোনো অফার না মিললেও বা fields ব্যবহার করলেও। access_enabled আপনার অ্যাকাউন্টের অনুমতি দেখায়। status হলো not_enabled, eligible, conversion_limited বা unavailable। native_cpc_available ও boost_click_rewards_available দেখায় এই পুরস্কারগুলো আপনার অ্যাকাউন্টে বর্তমানে পাওয়া যায় কি না।

প্রতিবার সিঙ্ক করার সময় এই মানগুলো তুলনা করুন। মান বদলালে updated_since ছাড়া পুরো ফিড রিফ্রেশ করুন এবং সংরক্ষিত অফার তালিকা প্রতিস্থাপন করুন। এই অবস্থা প্রতিটি ক্লিকের পুরস্কারের নিশ্চয়তা দেয় না; ক্লিকের অন্যান্য যাচাই প্রযোজ্য থাকে।

র‌্যাঙ্কিং & দেশভিত্তিক পেআউট

  • Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
  • কিছু অফার দেশের ভেদে ভিন্ন পরিমাণ পরিশোধ করে. যদি কোনো অফারে "পৃথক দেশভিত্তিক পেআউট" তালিকা থাকে, তবে ব্যবহারকারীর দুই অক্ষরের দেশ কোডের সাথে মিলে এমন পেআউট ব্যবহার করুন (যেমন, US, CA, GB). যদি তাদের দেশ তালিকায় না থাকে, তবে "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.
  • ইভেন্ট অফারে ফেরার সময় একই subid বা বিজ্ঞাপন ID ব্যবহার করুন। আমরা প্রথম ক্লিক এবং তার ৩০ দিনের সময়সীমা রাখি। অফার আবার খুললে তা নতুন করে শুরু হয় না। ID ছাড়া সরাসরি লিংক ব্রাউজার কুকি ব্যবহার করে; ব্রাউজার বা ট্র্যাকিং ডোমেন বদলালে অথবা কুকি মুছলে পরিচয় হারাতে পারে।
  • 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.

অফার এপিআই নোট

  • API-এর মাধ্যমে CPC অফার ও বুস্ট ক্লিকের পুরস্কার শুধু সেই CPAlead Premium সদস্যদের জন্য, যাঁরা $100 সদস্যপদ ফি দিয়েছেন এবং যাঁদের CPC API অ্যাক্সেস চালু আছে।
  • যদি কোনো অফারে বুস্ট ক্লিক থাকে, তবুও এটি তার স্বাভাবিক র‌্যাঙ্কই রাখে. শুধু বুস্ট ক্লিক থাকলেই এটি উপরে উঠে আসে না.
  • API যে লিঙ্ক ফেরত দেয় সেটি হুবহু ব্যবহার করুন। নিজের সিস্টেমে অফার ID থেকে CPAlead ট্র্যাকিং লিঙ্ক নতুন করে তৈরি করবেন না।
  • CPA, CPI বা CPE অফারে যোগ্য বুস্ট ক্লিকের জন্য যুক্তরাষ্ট্রের ভিজিটর হলে $0.10 এবং অন্যান্য দেশের ভিজিটর হলে $0.07 দেওয়া হয়। পুরস্কারের জন্য বুস্ট ক্লিক অবশিষ্ট থাকতে হবে এবং ক্লিকের যোগ্যতার স্বাভাবিক সীমা প্রযোজ্য থাকবে।
  • সরাসরি CPC অফারের ক্ষেত্রে cpc_reward_type হলো native এবং amount হলো প্রতি ক্লিকে আপনার প্রাপ্য অর্থ। বুস্ট করা অফারের ক্ষেত্রে cpc_reward_type হলো boost_click এবং amount কনভার্শনের পেমেন্টই থাকে। boost_click_balance অবশিষ্ট বুস্ট ক্লিকের সংখ্যা দেখায়। অফারের লক্ষ্যভুক্ত দেশ অনুযায়ী API cpc_payout_us, cpc_payout_not_us অথবা দুটিই ফেরত দেয়। এই ক্লিকের পুরস্কার শুধু পাবলিশারকে দেওয়া হয়। এগুলো পাবলিশার পোস্টব্যাক পাঠায় না বা পোস্টব্যাকের মাধ্যমে কনটেন্ট আনলক করে না।

এন্ডপয়েন্ট

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

উপলব্ধ এইচটিটিপি কোয়েরি প্যারামিটার

এইচটিটিপি প্যারামিটার বর্ণনা
id Required. Your publisher ID.
country শুধু নির্দিষ্ট দেশের অফার দেখান, দুই অক্ষরের আইএসও দেশ কোড দিতে হবে
ব্যবহার করুন country=user ব্যবহারকারীর দেশের অফার স্বয়ংক্রিয়ভাবে পেতে
limit ফেরত দেওয়া অফারের সংখ্যা সীমিত করুন. এতে আপনার এপিআই কল দ্রুত হতে পারে. ডিফল্ট ২৫০০ এবং সর্বোচ্চ ৫০০০.
type ডিফল্টভাবে এই API CPA, CPI, CPE ও CPT অফার ফেরত দেয়। সরাসরি CPC অফার ও বুস্ট ক্লিকের পুরস্কারের জন্য অর্থ দিয়ে নেওয়া CPAlead Premium সদস্যপদ এবং চালু CPC API অ্যাক্সেস প্রয়োজন। কমা দিয়ে আলাদা করে পেমেন্টের ধরনের তালিকা দিতে পারেন, যেমন &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

শুধুমাত্র আপনার প্রয়োজনীয় অফার ক্ষেত্রগুলো ফেরত দিক. কমা-আলাদা তালিকা ব্যবহার করুন, উদাহরণস্বরূপ &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 বুলিয়ান (সত্য|মিথ্যা). আপনি যদি অফারওয়ালের জন্য চিহ্নিত অফারও চান তাহলে সত্য ব্যবহার করুন. সিপিসি অফার তবুও বাইরেই থাকে, এবং বুস্ট-ক্লিক অফারগুলো তাদের স্বাভাবিক র‌্যাঙ্কই রাখে.
device

স্বয়ংক্রিয় ডিভাইস টার্গেটিং ব্যবহার না করলে শুধুমাত্র এটি ব্যবহার করুন. ডিফল্টভাবে, এপিআই সব ধরনের ডিভাইস ফেরত দিতে পারে. শুধু নির্দিষ্ট ডিভাইস টাইপ ফেরত দিতে এই ক্ষেত্রটি ব্যবহার করুন. উপলব্ধ মানগুলো: ios, android, mobile, and desktop. ডিভাইস কমা-আলাদা তালিকাও হতে পারে, উদাহরণস্বরূপ: &device=ios,android,mobile,desktop

শুধুমাত্র সিপিআই / সিপিই অফার পেতে (যেখানে রূপান্তরের জন্য শুধু ইনস্টল প্রয়োজন - ব্যবহার করুন device=ios,android

ব্যবহার করুন device=user ব্যবহারকারীর ডিভাইস স্বয়ংক্রিয়ভাবে পেতে

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.
অতিরিক্ত তথ্যের জন্য দ্বিতীয় সাবআইডি ভেরিয়েবল
অতিরিক্ত তথ্যের জন্য তৃতীয় সাবআইডি ভেরিয়েবল
gaid / idfa মোবাইলের জন্য আপনার গুগল বিজ্ঞাপন আইডি (জিএআইডি) থাকলে, আপনার ট্র্যাকিং লিঙ্কে স্বয়ংক্রিয়ভাবে জিএআইডি ভরতে এই ভেরিয়েবলটি ব্যবহার করুন
মোবাইলের জন্য আপনার অ্যাপল বিজ্ঞাপনদাতাদের জন্য পরিচয়কারী (আইডিএফএ) থাকলে, আপনার ট্র্যাকিং লিঙ্কে স্বয়ংক্রিয়ভাবে আইডিএফএ ভরতে এই ভেরিয়েবলটি ব্যবহার করুন
format / callback জেসন অথবা জেসনপ ফরম্যাট. জেসন হল ডিফল্ট
জেসনপি কলব্যাক ফাংশনের নাম. শুধুমাত্র জেসনপি ফরম্যাটের জন্য ব্যবহৃত হয়. জেকোয়েরি গেটজেসন ব্যবহার করলে, কলব্যাক=? ব্যবহার করুন এবং জেকোয়েরি স্বয়ংক্রিয়ভাবে আপনার জন্য ফাংশনের নাম ভরে দেবে. জেসনপি উদাহরণ দেখুন

প্রতিক্রিয়ার উদাহরণ


                                
                                

প্রতিক্রিয়ার উদাহরণ: HTTP 403


                                
                            

কোডের উদাহরণ


                                
                            

বুস্ট ক্লিকসহ রেসপন্সের উদাহরণ

ফি দেওয়া এবং CPC API অ্যাক্সেস থাকা Premium সদস্যের জন্য নমুনা রেসপন্স। এই CPI অফার যুক্তরাষ্ট্র ও কানাডার জন্য, তাই বুস্ট পেমেন্টের দুটি ফিল্ডই দেখানো হয়েছে। amount হলো কনভার্শনের পেমেন্ট; CPC ফিল্ডগুলো সম্ভাব্য ক্লিকের পুরস্কার দেখায়।


                        
                    

02

রূপান্তর এপিআই

Conversions এবং Reversals একই অনুরোধ সীমা ব্যবহার করে।
রূপান্তর এপিআই আপনাকে রূপান্তর পরীক্ষার জন্য সিপিএলিডকে পিং করতে দেয়, যা কাস্টম অ্যাপ তৈরির জন্য উপকারী. সাবআইডি অথবা আইপি ঠিকানা হিসেবে সাবআইডি পাঠান, অথবা "ব্যবহারকারী" পাঠান যাতে আমাদের সিস্টেম এই স্ক্রিপ্ট কল করা ক্লায়েন্টের আইপি ঠিকানা ব্যবহার করে (জেসনপি কলের জন্য উপকারী)
পুশ-ধরনের রূপান্তর সেবার জন্য (সার্ভার-টু-সার্ভার পোস্টব্যাক), আমাদের পোস্টব্যাক নথিপত্র দেখুন

কোনো API অনুরোধে HTTP 429 এলে আবার চেষ্টা করার আগে Retry-After-এ উল্লেখ করা সেকেন্ড অপেক্ষা করুন। X-RateLimit-Limit এবং X-RateLimit-Remaining দেখুন এবং বারবার ব্যর্থ হলে অপেক্ষার সময় বাড়ান।

এন্ডপয়েন্ট

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

উপলব্ধ এইচটিটিপি কোয়েরি প্যারামিটার

এইচটিটিপি প্যারামিটার বর্ণনা
id Required. Your publisher ID.
api_key Required. Your API key.
subid আবশ্যক. সাবআইডির ভিত্তিতে রূপান্তর খুঁজুন, সাবআইডি অথবা ব্যবহারকারীর আইপি ঠিকানা পাঠান, "ব্যবহারকারী" পাঠান ক্লায়েন্টের আইপি ঠিকানা ব্যবহার করতে যে এই স্ক্রিপ্ট কল করছে (জেসনপি কলের জন্য উপকারী)
offer_id ঐচ্ছিক. শুধুমাত্র এই অফার (ক্যাম্পেইন) আইডির জন্য রূপান্তর যাচাই করবে
format / callback জেসন অথবা জেসনপ ফরম্যাট. জেসন হল ডিফল্ট
জেসনপি কলব্যাক ফাংশনের নাম. শুধুমাত্র জেসনপি ফরম্যাটের জন্য ব্যবহৃত হয়. জেকোয়েরি গেটজেসন ব্যবহার করলে, কলব্যাক=? ব্যবহার করুন এবং জেকোয়েরি স্বয়ংক্রিয়ভাবে আপনার জন্য ফাংশনের নাম ভরে দেবে. জেসনপি উদাহরণ দেখুন

প্রতিক্রিয়ার উদাহরণ


                            
                        

03

রিভার্সাল এপিআই

Conversions এবং Reversals একই অনুরোধ সীমা ব্যবহার করে।
দুটি তারিখের মধ্যে আপনার খারাপ লিডগুলোর তালিকা ডাউনলোড করতে এই এপিআই ব্যবহার করুন. খারাপ ট্রাফিক বাছাই করার জন্য উপকারী

কোনো API অনুরোধে HTTP 429 এলে আবার চেষ্টা করার আগে Retry-After-এ উল্লেখ করা সেকেন্ড অপেক্ষা করুন। X-RateLimit-Limit এবং X-RateLimit-Remaining দেখুন এবং বারবার ব্যর্থ হলে অপেক্ষার সময় বাড়ান।

এন্ডপয়েন্ট

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

উপলব্ধ এইচটিটিপি কোয়েরি প্যারামিটার

এইচটিটিপি প্যারামিটার বর্ণনা
id Required. Your publisher ID.
api_key Required. Your API key.
start_date খারাপ লিড টানার সময় যে শুরুর তারিখ ব্যবহার করা হবে. ফরম্যাট: yyyy-mm-dd
end_date খারাপ লিড টানার সময় যে শেষ তারিখ ব্যবহার করা হবে. একবারে সর্বোচ্চ এক মাস নেয়া যেতে পারে
format / callback জেসন অথবা জেসনপ ফরম্যাট. জেসন হল ডিফল্ট
জেসনপি কলব্যাক ফাংশনের নাম. শুধুমাত্র জেসনপি ফরম্যাটের জন্য ব্যবহৃত হয়. জেকোয়েরি গেটজেসন ব্যবহার করলে, কলব্যাক=? ব্যবহার করুন এবং জেকোয়েরি স্বয়ংক্রিয়ভাবে আপনার জন্য ফাংশনের নাম ভরে দেবে. জেসনপি উদাহরণ দেখুন

প্রতিক্রিয়ার উদাহরণ