Le point d’entrée de l’API est https://api.affilae.com/2.0/ et est uniquement accessible depuis le protocol HTTPS.

Les données échangées sont au format JSON.

Authentification

Pour se connecter à l’API, vous devez générer une clé d’accès depuis le menu « Mon Compte » > « Clé API ».
Votre code utilisateur vous sera également fourni à ce moment là.

Si votre compte utilisateur n’est pas administrateur et possède des droits restreints, ses droits seront identiques sur l’API.

L’authentification se fait via l’entête HTTP Authorization: Basic user:password, où la chaîne user:password doit être encodé en base 64. Le user est votre code utilisateur et le password est votre clé API.

 

Côté annonceur


/advertiser -> Liste les programmes disponibles

GET https://api.affilae.com/2.0/advertiser

Réponse

Collection JSON

idstringID
titlestringTitre du programme
slugstringTitre du programme URLizé
urlstringURL du site annonceur


/advertiser/{programId} -> Détails du programme

GET https://api.affilae.com/2.0/advertiser/{programId}

Réponse

Objet JSON

titlestringTitre du programme
slugstringTitre du programme URLizé
urlstringURL du site annonceur
teaserstringRésumé du programme
descriptionstringDescription détaillée du programme
termsstringConditions d’affiliation
tagsstring|nullMots clés
modefirst|last|shareMode d’attribution des conversions
default_affiliate_weightintPoids par défaut d’un affilié
advertiser_weightintPoids du site annonceur
minimum_amountintGains minimum avant demande de paiement
approve_affiliates0|1Approbation manuelle des nouveaux affiliés
authorize_brand_name0|1Autoriser le SEO avec le nom de l’annonceur
authorize_text_link0|1Autoriser les liens textes
authorize_newsletter0|1Autoriser les newsletters
authorize_pop_up0|1Autoriser les pop-up
authorize_pop_under0|1Autoriser les pop-under
authorize_incentive_form0|1Autoriser l’incitation au CPL
authorize_buy_keywords0|1Autoriser l’achat de mots-clés (adWords…)
authorize_coregistration0|1Autoriser la coregistration
created_attimestampDate de création du programme
idstringID du programme
rulesjson collection
rules > titlestringNom de la règle de commissionnement
rules > idstringID de la règle de commissionnement


/advertiser/{programId}/conversions -> Liste des conversions

GET https://api.affilae.com/2.0/advertiser/{programId}/conversions?parameter=value

Requête

ParamètreValeurDescription
identifierstringFiltrer par identifiant de conversion (numéro de commande…)
partnershipIdstringFiltrer par partenariat
isPending0|1Filtrer par statut « en attente » des conversions
isLocked0|1Filtrer par conversions vérouillées
isRefused0|1Filtrer par conversions refusées
dateFromtimestampFiltrer par date de conversion
dateTotimestampFiltrer par date de conversion
skipintIgnorer les x premiers résultats
limitint 0-100Limiter le nombre de résultats. Défaut: 20
orderBydesc|ascTrier les résultats par date de conversion. Défaut: desc
count0|1Renvoyer le nombre de résultats. Defaut: 0

Réponse

Collection JSON

{#
#}

identifierstringIdentifiant de conversion (numéro de commande…)
amountfloatMontant de la conversion
currencystringDevise de la conversion
customer_idstringID client conversionpaymentcheque|bankwire|online|other|nullMoyen de paiement du clientmodefirst|last|share|manualMode d’attribution des commissionsis_pending0|1La conversion est-elle en attentelocked_attimestamp|nullDate à laquelle le statut de la conversion sera vérouillérefused_attimestamp|nullDate à laquelle la conversion a été refuséecustom_varstring|nullVariable persocreated_attimestampDate de la conversionidstringID de la conversion


/advertiser/{programId}/conversions/{conversionId} -> Détail de la conversion

GET https://api.affilae.com/2.0/advertiser/{programId}/conversions/{conversionId}

Réponse

Objet JSON

identifierstringIdentifiant de conversion (numéro de commande…)
amountfloatMontant de la conversion
commission_paidfloatMontant de la commission versée
paymentcheque|bankwire|online|other|nullMoyen de paiement du client
modefirst|last|share|manualMode d’attribution des commissions
shared_betweenintNombre d’affiliés ayant contribué à la conversion
is_first0|1L’annonceur a-t’il initié le processus de conversion
cookietimestamp|nullDate de la première visite, si l’annonceur a initié la conversion
advertiser_weightint|nullPoids de l’annonceur si mode=share
advertiser_percentint|nullPourcentage de la commission prélevé par l’annonceur si is_first=1
from_revenue_sharing0|1La conversion est-elle récurrente
is_pending0|1La conversion est-elle en attente
locked_attimestamp|nullDate à laquelle le statut de la conversion sera vérouillé
refused_attimestamp|nullDate à laquelle la conversion a été refusée
refuse_reasonstringRaison du refus de la conversion
custom_varstring|nullVariable perso
created_attimestampDate de la conversion
idstringID de la conversion
rulejson object
rule > titlestringNom de la règle de commissionnement
rule > idstringID de la règle de commissionnement
commissionsjson collection
commissions > idstringID de la commission.
commissions > percent0|floatPourcentage du total des commissions. Vaut 0 quand un canal externe déduit une commission fixe.
commissions > commissionfloatMontant de la commission
commissions > cookietimestampDate du clic du tracking
commissions > custom_varstring|nullVariable personalisée injectée dans les trackings (#aev)
commissions > referrerstring|nullURL référente du clic d’affiliation
commissions > partnershipjson object|voidPartenariat
commissions > partnership > idstringID du partenariat d’affiliation
commissions > partnership > tracking_idintID des URLs de tracking
commissions > partnership > affiliateProfilejson objectProfil d’affilié
commissions > partnership > affiliateProfile > titlestringNom du profil d’affilié
commissions > partnership > affiliateProfile > idstringID du profil d’affilié
commissions > paymentRequestjson object|voidDemande de paiement associé à cette commission si elle appartient à un affilié
commissions > paymentRequest > idstring|nullID de la demande de paiement

/advertiser/{programId}/conversions/{conversionID}/accept -> Accepter une conversion

GET https://api.affilae.com/2.0/advertiser/{programId}/conversions/{conversionID}/accept

La conversion doît être soit en attente ou soit non verouillée et refusée.

Réponse

Objet JSON

statusdone|aborted|failedStatut du traitement
messagestringMessage


/advertiser/{programId}/conversions/{conversionID}/refuse -> Refuser une conversion

POST https://api.affilae.com/2.0/advertiser/{programId}/conversions/{conversionID}/refuse

La conversion doît être soit en attente ou soit non verouillée et acceptée.

Requête

Objet JSON dans le Body

refuse_reasonstringRaison du refus de la conversion

Réponse

Objet JSON

statusdone|aborted|failedStatut du traitement
messagestringMessage

/advertiser/{programId}/conversions/add -> Ajouter une conversion

POST https://api.affilae.com/2.0/advertiser/{programId}/conversions/add

Requête

Objet JSON dans le Body

identifierstringIdentifiant unique pour la conversion
partnership_idstringID du partenariat
amountfloat|0Montant Hors Taxes de la conversion
commissionfloatMontant Hors Taxes de la commission
rule_idstringID de la règle de commissionnement concernée
custom_varstring|nullVariable perso optionnelle

Réponse

Objet JSON

statusdone|aborted|failedStatut du traitement
messagestringMessage
codeintStatus code


/advertiser/{programId}/partnerships -> Liste des partenariats

GET https://api.affilae.com/2.0/advertiser/{programId}/partnerships?parameter=value

Requête

ParamètreValeurDescription
partnershipIdstringFiltrer par partenariat
trackingIdintFiltrer par l’ID de tracking affilié
skipintIgnorer les x premiers résultats
limitint 0-100Limiter le nombre de résultats. Défaut: 20
orderBydesc|ascTrier les résultats par date d’inscription. Défaut: desc
count0|1Renvoyer le nombre de résultats. Defaut: 0

Réponse

Collection JSON

idstringID du partenariat
tracking_idintIdentifiant de tracking de l’affilié
status0|1|9Status de l’affilié. 0: En attente, 1: Accepté, 9:Refusé
url_paramstring|nullParamètres d’URL de tracking personalisés
url_sharp_paramstring|nullAncres d’URL de tracking personalisés
weightint [0-12]Poids de l’affilié en cas de partage de la commission
cpcfloat|nullCoût personnalisé des CPC
created_attimestampDate de la conversion
affiliateProfilejson objectProfil d’affilié
affiliateProfile > idstringID du profil d’affilié
affiliateProfile > titlestringNom du profil d’affilié


/advertiser/{programId}/clicks -> Liste des clics

GET https://api.affilae.com/2.0/advertiser/{programId}/clicks?parameter=value

Requête

ParamètreValeurDescription
partnershipIdstringFiltrer par partenariat
ipstringFiltrer par adresse IP de l’internaute
skipintIgnorer les x premiers résultats
limitint 0-100Limiter le nombre de résultats. Défaut: 20
orderBydesc|ascTrier les résultats par date de creation. Défaut: desc
count0|1Renvoyer le nombre de résultats. Defaut: 0

Réponse

Collection JSON

cookie_idstringID du click, également présent dans le cookie
partnership_idstringID du partenariat affilié
ad_idstring|nullID de l’élément pub cliqué
cpcfloat|nullCPC du click
currencystringDevise du CPC
custom_varstring|nullVariable perso
referrerstring|nullPage référente du clic
landing_pagestringPage de destination du clic
ipstringAdresse IP de l’internaute
created_attimestampDate du clic


/advertiser/{programId}/ads/add-tweet -> Ajouter un tweet

POST https://api.affilae.com/2.0/advertiser/{programId}/ads/add-tweet

Requête

Objet JSON dans le Body

ParamètreValeurDescription
titlestringTitre de l’élément pub
urlurlURL de la landing-page
contentstringContenu du tweet, doit contenir le mot AFFILIATE_LINK
tagsstringOptionnel: tags séparés par une virgule

Réponse

Objet JSON

statusdone|aborted|failedStatut du traitement
messagestringMessage
codeintStatus code

Côté éditeur


/publisher -> Liste les profils affiliés disponibles

GET https://api.affilae.com/2.0/publisher

Réponse

Collection JSON

idstringID
titlestringTitre du profil
slugstringTitre du profil URLizé
urlstringURL du profil


/publisher/{profileId} -> Détails du profil

GET https://api.affilae.com/2.0/publisher/{profileId}

Réponse

Objet JSON

idstringID du profil
titlestringTitre du profil
slugstringTitre du profil URLizé
urlstringURL du profil
teaserstringRésumé du profil
descriptionstringDescription détaillée du profil
tagsstring|nullMots clés
pages_viewsint|nullNombre de pages vues / mois
unique_visitorsint|nullNombre de visiteurs uniques / mois
notification_messagebooleanRecevoir des notifications pour les nouveaux messages
notification_conversionbooleanRecevoir des notifications pour les nouvelles conversions
created_attimestampDate de création du profil


/publisher/{profileId}/partnerships -> Liste des partenariats

GET https://api.affilae.com/2.0/publisher/{profileId}/partnerships?parameter=value

Requête

ParamètreValeurDescription
partnershipIdstringFiltrer par partenariat
trackingIdintFiltrer par l’ID de tracking affilié
skipintIgnorer les x premiers résultats
limitint 0-100Limiter le nombre de résultats. Défaut: 20
orderBydesc|ascTrier les résultats par date d’inscription. Défaut: desc
count0|1Renvoyer le nombre de résultats. Defaut: 0

Réponse

Collection JSON

idstringID du partenariat
tracking_idintIdentifiant de tracking d’affiliation
status0|1|9Status du partenariat. 0: En attente, 1: Accepté, 9:Refusé
url_paramstring|nullParamètres d’URL de tracking personalisés
url_sharp_paramstring|nullAncres d’URL de tracking personalisés
weightint [0-12]Poids du profil affilié en cas de partage de la commission
cpcfloat|nullCoût personnalisé des CPC
created_attimestampDate du partenariat
programjson objectProgramme d’affiliation
program > idstringID du programme d’affiliation
program > titlestringNom du programme d’affiliation


/publisher/{profileId}/commissions -> Liste des commissions

GET https://api.affilae.com/2.0/publisher/{profileId}/commissions?parameter=value

Requête

ParamètreValeurDescription
identifierstringFiltrer par identifiant de conversion (numéro de commande…)
partnershipIdstringFiltrer par partenariat
isPending0|1Filtrer par statut « en attente » des commissions
excludeNull0|1Exclure les commissions à 0
isLocked0|1Filtrer par commissions vérouillées
isRefused0|1Filtrer par commissions refusées
dateFromtimestampFiltrer par date de conversion
dateTotimestampFiltrer par date de conversion
skipintIgnorer les x premiers résultats
limitint 0-100Limiter le nombre de résultats. Défaut: 20
orderBydesc|ascTrier les résultats par date de conversion. Défaut: desc
count0|1Renvoyer le nombre de résultats. Defaut: 0

Réponse

Collection JSON

idstringID de la commission
identifierstringIdentifiant de conversion (numéro de commande…)
commissionfloatMontant de la commission
amountfloatMontant de la conversion CPA
percentfloatPourcentage gagné en cas de partage de la commission
currencystringDevise de la commission
is_pendingbooleanLa commission est-elle en attente
locked_attimestamp|nullDate à laquelle le statut de la commission sera vérouillé
refused_attimestamp|nullDate à laquelle la conversion a été refusée
refuse_reasonstring|nullMotif du refus de la commission
cookietimestamp|nullDate du tracking
referrerstring|nullPage référente du clic
landing_pagestring|nullPage cible du clic
custom_varstring|nullVariable personnalisé passée dans le tracking
created_attimestampDate de la conversion
partnershipjson objectPartenariat
partnership > idstringID du partenariat d’affiliation
paymentRequestjson objectDemande de paiement, si existante
paymentRequest > idstringID de la demande de paiement


/publisher/{profileId}/ads -> Liste des éléments pubs

GET https://api.affilae.com/2.0/publisher/{profileId}/ads?parameter=value

Requête

ParamètreValeurDescription
typetwitterFiltrer par type (Twitter seulement pour le moment)
partnershipIdstringFiltrer par partenariat
skipintIgnorer les x premiers résultats
limitint 0-100Limiter le nombre de résultats. Défaut: 20
orderBydesc|ascTrier les résultats par date de conversion. Défaut: desc
count0|1Renvoyer le nombre de résultats. Defaut: 0

Réponse

Collection JSON

idstringID de l’élément pub
titlestringTitre de l’élément pub
typestringType d’élément pub
tagsjson arrayTags
created_attimestampDate de la conversion
partnershipjson objectPartenariat
partnership > idstringID du partenariat d’affiliation
partnership > program_titlestringTitre du programme d’affiliation
Twitter:
tweetstringContenu du tweet à poster