API publique du gestionnaire d'affiliation : endpoints et autorisations

Pilotez affiliés, commissions et paiements par API : groupes d'endpoints, scopes et comportements à connaître.

Écrit par Baptiste Lorreyte

Dernière mise à jour Il y a environ 4 heures

L'API publique du gestionnaire d'affiliation permet aux développeurs et aux créateurs d'applications de piloter un programme d'affiliation depuis leurs propres outils : affiliés, campagnes, clients référés, commissions, paiements, moyens de versement et médias.

Elle sert par exemple à construire un tableau de bord sur mesure ou à synchroniser vos commissions avec vos outils financiers. Pour la prise en main du module dans l'interface, consultez Démarrer votre programme d'affiliation dans CrocoClick.

La suite compte 32 endpoints au total : 28 nouveaux et 4 existants dont le fonctionnement a été resserré. Elle figure dans le catalogue de l'API v3 du Developer Marketplace.

Ce que vous pouvez faire

Gérer les affiliés sans l'interface : les intégrer, les modifier, les activer ou les désactiver depuis votre application.
Suivre commissions et paiements : alimenter vos tableaux de bord externes, vos rapprochements et vos processus financiers.
Attribuer les conversions : valider les identifiants de parrainage et créer des prospects depuis des pages et tunnels de paiement externes.
Collecter les coordonnées de versement : gérer les moyens de versement, avec la liste des champs bancaires requis par pays.

Les groupes d'endpoints

Tous les endpoints sont disponibles sous /affiliate-manager :

Groupe	Endpoints	Possibilités
Affiliés	10	Créer, lire, modifier et lister des affiliés. Les activer ou désactiver. Les déplacer entre campagnes. Définir et valider les identifiants de parrainage. Suspendre un affilié d'une campagne. Téléverser un formulaire fiscal.
Moyens de versement	6	Créer, lire, modifier et supprimer les moyens de versement d'un affilié. Définir le moyen principal. Consulter les champs bancaires requis par pays.
Commissions	5	Créer, lister et supprimer des commissions. Modifier leur statut. Les refuser.
Clients	5	Lister les clients référés par un affilié. Créer et valider des prospects. Modifier l'état d'un client. Supprimer un client.
Médias d'affiliation	3	Lister, modifier et supprimer les fichiers et dossiers de médias d'un compte.
Campagnes	2	Lister les campagnes et récupérer une campagne avec sa structure de commission.
Paiements	1	Lister les paiements d'un compte.

Comportements à connaître

Création d'un affilié : si un affilié possède déjà la même adresse email dans le compte, l'endpoint met à jour sa fiche au lieu de créer un doublon.
Modification d'un affilié : l'endpoint remplace toute la fiche. Les champs absents de la requête sont effacés, incluez donc tous ceux à conserver.
Identifiants de parrainage : ils doivent être uniques dans le compte, même entre campagnes différentes.
Suspension : suspendre un affilié d'une campagne annule ses paiements, commissions et transactions en attente ou refusés. Le réintégrer repasse les éléments annulés en attente.
Moyens de versement : un affilié peut avoir un moyen PayPal et un moyen bancaire. Le premier ajouté devient le moyen principal.
Suppression d'un moyen de versement : impossible de supprimer le moyen principal tant que l'affilié en possède plusieurs.
Données bancaires : la liste des moyens de versement ne renvoie que les quatre derniers caractères des comptes bancaires.

⚠️ Remarque : avant d'appeler l'endpoint de modification sur de vraies fiches, vérifiez que votre requête contient tous les champs à conserver. Tout champ omis est effacé.

Authentification et autorisations

L'API utilise OAuth 2.0 v3 avec un accès au niveau du compte. Deux scopes déterminent ce que votre application peut faire :

affiliate-manager.readonly : requis pour les 12 endpoints de lecture.
affiliate-manager.write : requis pour les 20 endpoints de création, de modification ou de suppression.

Démarrer

Ouvrez la documentation de l'API v3 du gestionnaire d'affiliation dans le Developer Marketplace.
Créez ou ouvrez votre application, puis activez le ou les scopes nécessaires.
Autorisez l'application pour le compte concerné avec OAuth 2.0. La documentation OAuth 2.0 détaille l'enregistrement de l'application, ses réglages, son installation et l'obtention des jetons d'accès.
Appelez les endpoints du groupe voulu. Chaque groupe a sa page de référence, avec le détail des requêtes et des réponses.

Cas d'usage

Un tableau de bord d'affiliation personnalisé pour vos clients.
La synchronisation des affiliés, commissions et paiements avec votre CRM ou vos outils financiers.
L'intégration des affiliés depuis votre propre parcours d'inscription, coordonnées de versement comprises.
L'attribution des prospects et des ventes issus de pages et tunnels de paiement externes.

Questions fréquentes

Faut-il une application dans le Developer Marketplace ?

L'API utilise OAuth 2.0 v3 : votre intégration doit être autorisée pour le compte dont elle consulte les données d'affiliation.

Où trouver des exemples de requêtes et de réponses ?

Dans la section du gestionnaire d'affiliation de la documentation de l'API. Chaque groupe d'endpoints a sa propre page de référence.

Cela a-t-il été utile ?

Besoin d'aide supplémentaire ? Demander à l'équipe