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 des offres API des conversions API des annulations

Vous souhaitez gérer des campagnes d’annonceur ?

L’API Publisher présentée sur cette page sert à récupérer des offres et les rapports destinés aux éditeurs. Les annonceurs peuvent utiliser l’API Campaign distincte pour valider, créer, modifier, démarrer et suspendre des campagnes en libre-service, y compris avec l’aide d’un agent d’IA.

Lire le guide de l’API Campaign pour les annonceurs

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: Membres CPAlead Premium ayant payé leur adhésion uniquement
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

Les gains CPC et par clic boosté nécessitent une adhésion CPAlead Premium payante et un accès CPC API activé. Les offres boostées conservent leur classement normal.

OpenAPI File

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

API des offres

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

Votre accès CPC API

Connectez-vous pour voir votre accès

Pourquoi les gains par clic peuvent être suspendus

Les offres CPC et les gains par clic boosté peuvent être temporairement limités si votre trafic génère des clics répétés sans suffisamment de conversions CPA ou CPI éligibles. Cette mesure protège les annonceurs contre les bots et le trafic non valide.

Les offres CPC natives et les champs de gains par clic boosté sont masqués dans votre flux API pendant cette suspension. Les conversions CPA ou CPI éligibles lèvent automatiquement la suspension. Les offres de conversion éligibles restent disponibles. Actualisez votre flux complet pour mettre à jour les offres disponibles ; les autres critères d’éligibilité des clics restent applicables.

Statut d’éligibilité CPC

Chaque réponse réussie inclut cpc_eligibility, même si aucune offre ne correspond ou si fields est utilisé. access_enabled indique votre autorisation de compte. status vaut not_enabled, eligible, conversion_limited ou unavailable. native_cpc_available et boost_click_rewards_available indiquent si ces gains sont actuellement disponibles pour votre compte.

Comparez ces valeurs à chaque synchronisation. Lorsqu’elles changent, actualisez le flux complet sans updated_since et remplacez votre liste enregistrée. Le statut ne garantit pas un gain pour chaque clic ; les autres vérifications des clics restent applicables.

Classement & Paiements par pays

Each offer includes an offer_rank where 1 is the highest ranked offer. Results stay in offer_rank order from low to high.
Certaines offres paient des montants différents selon le pays. Si une offre inclut une liste "payouts_per_country", utilisez le paiement qui correspond au code pays à deux lettres de l'utilisateur (par ex. US, CA, GB). Si leur pays ne se trouve pas dans la liste, utilisez le paiement par défaut indiqué dans "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.
Utilisez le même subid ou identifiant publicitaire pour revenir à une offre à événements. Le clic initial et son délai de 30 jours sont conservés. Rouvrir une offre ne la redémarre pas. Sans identifiant, les liens directs utilisent un cookie ; changer de navigateur ou de domaine de suivi, ou effacer les cookies, peut faire perdre cette identité.
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.

Notes sur l'API des offres

Les offres CPC et les gains par clic boosté via l’API sont réservés aux membres CPAlead Premium ayant payé les frais d’adhésion de 100 $ et dont l’accès CPC API est activé.
Si une offre dispose de boost clicks, elle conserve quand même son rang normal. Elle n'est pas placée en tête simplement parce qu'elle a des boost clicks.
Utilisez le lien exact renvoyé par l’API. Ne reconstruisez pas les liens de suivi CPAlead à partir des identifiants d’offres dans votre propre système.
Les clics boostés éligibles sur les offres CPA, CPI ou CPE rapportent 0,10 $ pour les visiteurs des États-Unis et 0,07 $ pour les visiteurs des autres pays. Des clics boostés doivent encore être disponibles et les règles habituelles d’éligibilité des clics s’appliquent.
Pour les offres CPC natives, cpc_reward_type vaut native et amount indique votre gain par clic. Pour les offres boostées, cpc_reward_type vaut boost_click et amount reste le paiement par conversion. boost_click_balance indique le nombre de clics boostés restants. L’API renvoie cpc_payout_us, cpc_payout_not_us ou les deux, selon les pays ciblés par l’offre. Ces gains par clic sont versés uniquement à l’éditeur et ne déclenchent ni postback éditeur ni déverrouillage de contenu par postback.

Point d'accès

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

Paramètres de requête HTTP disponibles

Paramètre HTTP	Description
id	Required. Your publisher ID.
country	Afficher uniquement les offres du pays, fournissez le code pays ISO à deux lettres Utilisez `country=user` pour obtenir automatiquement les offres du pays de l'utilisateur
limit	Limitez le nombre d'offres renvoyées. Cela peut accélérer vos appels API. La valeur par défaut est 2500 et le maximum est 5000.
type	Par défaut, cette API renvoie des offres CPA, CPI, CPE et CPT. Les offres CPC natives et les gains par clic boosté nécessitent une adhésion CPAlead Premium payante et un accès CPC API activé. Vous pouvez demander plusieurs types de paiement séparés par des virgules, par exemple `&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	Ne renvoyez que les champs d'offre dont vous avez besoin. Utilisez une liste séparée par des virgules, par exemple `&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	Booléen (vrai\|faux). Utilisez vrai si vous voulez aussi des offres marquées pour les offerwalls. Les offres CPC restent exclues, et les offres boost-click conservent leur rang normal.
device	Utilisez-cela uniquement si vous n'utilisez pas la ciblage automatique des appareils. Par défaut, l'API peut renvoyer tous les types d'appareils. Utilisez ce champ pour ne renvoyer que certains types d'appareils. Valeurs disponibles : ios, android, mobile et desktop. L'appareil peut aussi être une liste séparée par des virgules, par exemple: `&device=ios,android,mobile,desktop` Pour obtenir uniquement les offres CPI / CPE (qui nécessitent uniquement l'installation pour la conversion - utilisez device=ios,android Utilisez `device=user` pour obtenir automatiquement les offres de l'appareil de l'utilisateur
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. Une deuxième variable subid pour des données supplémentaires Une troisième variable subid pour des données supplémentaires
gaid / idfa	Si vous avez un Google Advertising ID (GAID) pour mobile, utilisez cette variable pour remplir automatiquement le gaid sur votre lien de suivi Si vous avez un Apple Identifier For Advertisers (IDFA) pour mobile, utilisez cette variable pour remplir automatiquement l'idfa sur votre lien de suivi
format / callback	Format JSON ou JSONP. JSON est la valeur par défaut Nom de la fonction de rappel JSONP. Utilisé uniquement pour le format JSONP. Si vous utilisez jQuery getJSON, utilisez callback=? et jQuery remplira automatiquement le nom de la fonction pour vous. Voir l'exemple JSONP

Exemple de réponse

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

Exemple de réponse: HTTP 403

Exemple de code

<!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>

Exemple de réponse avec clics boostés

Exemple de réponse pour un membre Premium ayant payé son adhésion et disposant de l’accès CPC API. Cette offre CPI cible les États-Unis et le Canada, donc les deux champs de paiement boost sont affichés. amount correspond au paiement par conversion ; les champs CPC indiquent les gains possibles par clic.

{
    "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 des conversions

Conversions et Reversals partagent une limite de requêtes.
L'API de conversion vous permet de ping CPAlead pour tester les conversions, utile pour créer des applications personnalisées. Passez subid en tant que subid ou adresse IP, ou "user" pour que notre système utilise l'adresse IP du client appelant ce script (utile pour les appels JSONP)
Pour le service de conversion de type push (Postback serveur à serveur), voir notre documentation Postback

Si une requête API renvoie HTTP 429, attendez le nombre de secondes indiqué dans Retry-After avant de réessayer. Consultez X-RateLimit-Limit et X-RateLimit-Remaining, et augmentez le délai après des échecs répétés.

Point d'accès

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

Paramètres de requête HTTP disponibles

Paramètre HTTP	Description
id	Required. Your publisher ID.
api_key	Required. Your API key.
subid	Obligatoire. Recherche de conversion basée sur subid, passez subid ou l'adresse IP des utilisateurs, passez "user" pour utiliser l'adresse IP du client appelant ce script (utile pour les appels JSONP)
offer_id	Facultatif. Vérifiera la conversion uniquement pour cet ID d'offre (campagne)
format / callback	Format JSON ou JSONP. JSON est la valeur par défaut Nom de la fonction de rappel JSONP. Utilisé uniquement pour le format JSONP. Si vous utilisez jQuery getJSON, utilisez callback=? et jQuery remplira automatiquement le nom de la fonction pour vous. Voir l'exemple JSONP

Exemple de réponse

API des annulations

Conversions et Reversals partagent une limite de requêtes.
Utilisez cette API pour télécharger votre liste de mauvais prospects entre deux dates. Utile pour trier le mauvais trafic

Point d'accès

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

Paramètres de requête HTTP disponibles

Paramètre HTTP	Description
id	Required. Your publisher ID.
api_key	Required. Your API key.
start_date	Date de début à utiliser lors de la récupération des mauvais prospects. Format : yyyy-mm-dd
end_date	Date de fin à utiliser lors de la récupération des mauvais prospects. Un maximum d'un mois peut être récupéré à la fois
format / callback	Format JSON ou JSONP. JSON est la valeur par défaut Nom de la fonction de rappel JSONP. Utilisé uniquement pour le format JSONP. Si vous utilisez jQuery getJSON, utilisez callback=? et jQuery remplira automatiquement le nom de la fonction pour vous. Voir l'exemple JSONP

Exemple de réponse