Avant de commencer
API pour les offres
L'API Affise vous fournit de nombreuses méthodes pour travailler avec les offres : vous pouvez obtenir des informations ou les ajouter/modifier/supprimer. Grâce à l'API, vous pouvez gérer vos offres en permettant aux affiliés d'ajouter une ou plusieurs règles de plafonnement. Dans cet article, vous trouverez des exemples des requêtes API les plus populaires (méthodes) pour les offres avec des exemples cURL et des exemples de réponse.
Liste des offres
Utilisez cette méthode pour obtenir la liste des offres en fonction de leurs propriétés, que vous pouvez indiquer dans votre requête API.
La méthode: GET /3.0/offres.
La requête pour obtenir les offres avec le statut Active :
https://api-rocketcompany.affise.com/3.0/offers?api-key=4sdf87fsdfd8723lkjhrn324&status[]=active
Ajouter une offre
Utilisez cette méthode pour ajouter une offre au panneau d'administration. Dans le document de l'API, vous voyez des paramètres généraux ainsi que des paramètres de type tableau pour :
les paiements
pages d'atterrissage
plafonds
les niveaux de commission
groupes de ciblage
URL de suivi supplémentaires
structure du système d'exploitation
Créations HTML
calendrier des offres
Tous ces types de données ont des paramètres obligatoires :
un paramètre principal pour chaque type
un ou plusieurs paramètres obligatoires dans chaque tableau (marqués d'un * dans le document de l'API).
🔎 La liste des paramètres principaux pour chaque type de données :
payments : pour les paiements
landings : pour les pages d'atterrissage et les pages de préatterrissage
caps : pour les caps
commission_tiers: pour les niveaux de commission
targeting : pour les groupes de ciblage
schedule : pour le calendrier de l'offre
creativesHtml : pour les créations HTML
🔎 Les paramètres obligatoires pour la création d'une offre sont :
titre
annonceur
url
paiements
Si vous ne savez pas quelles valeurs ajouter (par exemple, les codes ISO pour les pays), utilisez les méthodes d'ici et d'ici, qui vous aideront à obtenir la liste des valeurs disponibles.
La méthode: POST /3.0/admin/offre
La requête cURL pour ajouter une offre avec les propriétés suivantes :
le statut Actif.
le niveau de confidentialité Private.
la case à cocher CPI sélectionnée.
la note.
un groupe cible général pour la France, l'Allemagne et l'Italie, pour Android >= 6.0.0.
un paiement général pour les mêmes pays, le type de paiement fixe en USD.
une règle de plafonnement pour 1000 conversions pour la période = mois, objectif = tous, affiliés = tous.
deux pages d'atterrissage.
curl --request POST \N- --url https://api-rocketcompany.affise.com/3.0/admin/offer \N- --header 'api-key : 4sdf87fsdfd8723lkjhrn324' \N- --header 'content-type : application/x-www-form-urlencoded' \N- --data 'title=New Offer' \N- --data advertiser=62fcd7ae7a3ccd7eacd7e4eb \N- --data 'url=http://new-tracking-link.network.com ?clickid={clickid}' \N- --data status=active \N- --data privacy=private \N- --data is_cpi=1 \N- --data 'notes=Il s'agit de l'offre la plus récente' \N- --data 'targeting[0][country][allow][0]=FR' \N- --data 'targeting[0][country][allow][1]=DE' \N- -data 'targeting[0][country][allow][1]=DE' \N- --data 'targeting[0][country][allow][1]=DE' \N- --data 'targeting[0][country][allow][2]=IT' \N- --data 'targeting[0][os][allow][0][name]=Android' \N- --data 'targeting[0][os][allow][0][comparison]=GTE' \N- --data 'targeting[0][os][allow][0][version]=6.0.0' \N- --data 'payments[0][countries][0]=FR' \N- --data 'payments[0][countries][1]=DE' \N- --data 'payments[0][countries][2]=IT' \N- -data 'payments[0][countries][1]=DE' \N- --data 'payments[0][countries][2]=IT' \N- --data 'payments[0][currency]=USD' \N- --data 'payments[0][type]=fixed' \N- --data 'caps[0][period]=month' \N- --data 'caps[0][type]=conversions' \N- --data 'caps[0][value]=1000' \N- --data 'caps[0][goal_type]=all' \N- --data 'caps[0][affiliate_type]=all' \N- --data 'landings[0][title]=Dating online' \N- --data 'landings[0][url]=http ://new-tracking-link.network.com?clickid={clickid}&sub1=online' \N- --data 'landings[0][url_preview]=http://new-tracking-link.network.com/online' \N- --data 'landings[1][title]=Dating offline' \N- --data 'landings[1][url]=http://new-tracking-link.network.com?clickid={clickid}&sub1=offline' \N- --data 'landings[1][url_preview]=http://new-tracking-link.network.com/offline'⚠️ Veillez à respecter toutes les exigences relatives au type de tableau de données, y compris les parenthèses et la numération.
Ajouter une offre avec un logo ou des créations
Utilisez cette méthode pour ajouter une offre avec un logo ou une création. En plus des paramètres obligatoires mentionnés précédemment, vous pouvez ajouter les paramètres suivants :
creativeFiles
creativeUrls
creativeDownloads
creativesHtml
creativeAssets
creativeFileTitles
creativeUrlTitles
creativeDownloadTitles
logo
⚠️ Si vous créez une offre manuellement via l'API et que vous souhaitez ajouter un logo ou des fichiers créatifs/téléchargements, veillez à utiliser l'en-tête suivant content-type : multipart/form-data.
La requête pourrait ressembler à ceci :
Vous pouvez voir une démo sur la façon d'ajouter un fichier avec un logo :
La requête cURL pour la création de l'offre avec le logo et les créations :
curl --location --request POST 'https://api-rocketcompany.affise.com/3.0/admin/offer' \N---header 'Content-Type : application/x-www-form-urlencoded' \N---header 'Content-Type : multipart/form-data' \N---header 'api-key : bf09c801ff9b95b14ac8e17d6e4904b6' \N---form 'title=OFFER WITH LOGO AND CREATIVES' \N---form 'advertiser=5e39279bac611cda7e5765ab' \N---form 'url=https://track.gjane.com/hc/click?afclick={clickid}&afpid={pid}&afoffer={offer_id}' \N---form 'logo=@/C:/Users/37525/Downloads/api.png' \N---form 'creativeFiles[0]=@/C:/Users/37525/Downloads/api.png' \N---form 'creativeUrls[1]=https://google.drive' \N---form 'creativeDownloads=https://google.drive/download' \N- --form 'creativeFiles[0]=@/C:/Users/37525/Downloads/api.png' \N- --form 'creativeUrls[1]=https://google.drive' \N- --form 'creativeDownloads=https://google.drive/download' \N- https://google.driveModifier une offre
Utilisez cette méthode pour modifier une offre : tous les paramètres ou seulement une partie de l'offre. Nous vous recommandons de lire l'article sur l'édition du type de tableau de données avant d'utiliser cette méthode.
La méthode: POST /3.0/admin/offre/{ID}
La requête cURL pour éditer un groupe de ciblage dans la même offre, qui est utilisée comme exemple pour ajouter l'offre. Dans l'exemple, les éléments suivants ont été modifiés :
La France, l'Allemagne et l'Italie ont été remplacées par l'Islande et l'Irlande.
la version du système d'exploitation est passée à 7.0.0.
l'outil proxy anti-fraude a été activé.
curl --request POST \N- --url https://api-rocketcompany.affise.com/3.0/admin/offer/1441594 \N- --header 'api-key : 4sdf87fsdfd8723lkjhrn324' \N- --header 'content-type : application/x-www-form-urlencoded' \N- --data 'targeting[0][country][allow][0]=IS' \N- --data 'targeting[0][country][allow][1]=IE' \N- --data 'targeting[0][block_proxy]=1' \N- -data 'targeting[0][country][allow][1]=IE' \N- --data 'targeting[0][block_proxy]=1' \N- --data 'targeting[0][os][allow][0][name]=Android' \N- --data 'targeting[0][os][allow][0][comparison]=GTE' \N- --data 'targeting[0][os][allow][0][version]=7.0.0' \N- --data =
⚠️ Veillez à respecter toutes les exigences relatives au type de tableau de données, y compris les parenthèses et la numération.
Activer les affiliés
Utilisez cette méthode pour permettre à votre affilié de travailler avec l'offre. Cette méthode n'est pertinente que si le niveau de confidentialité de l'offre est Pré-modération ou Privé.
La méthode: POST /3.0/offer/enable-affiliate.
La requête cURL pour l'activation de l'affilié #2 :
curl --request POST \N- --url https://api-rocketcompany.affise.com/3.0/offer/enable-affiliate \N- --header 'api-key : 4sdf87fsdfd8723lkjhrn324' \N- --header 'content-type : application/x-www-form-urlencoded' \N- --data offer_id=1441594 \N- --data pid=2
Désactiver les affiliés
Utilisez cette méthode pour permettre à votre affilié de travailler avec l'offre. Cette méthode est pertinente pour les offres avec tous les niveaux de confidentialité.
La méthode: POST /3.0/offer/enable-affiliate.
La requête cURL pour la désactivation de l'affilié #2 :
curl --request POST \N- --url https://api-rocketcompany.affise.com/3.0/offer/disable-affiliate \N- --header 'api-key : 4sdf87fsdfd8723lkjhrn324' \N- --header 'content-type : application/x-www-form-urlencoded' \N- --data offer_id=1441594 \N- --data pid=2
La liste des affiliés désactivés/activés
Utilisez cette méthode pour obtenir la liste des affiliés qui peuvent ou ne peuvent pas travailler avec l'offre en question.
La méthode: GET /3.1/offres/{ID}/privacy.
La requête :
https://api-rocketcompany.affise.com/3.1/offers/1441594/privacy?api-key=4sdf87fsdfd8723lkjhrn324
Mise à jour du statut des offres
Cette méthode permet de modifier en masse l'état des offres.
La méthode: POST /3.0/admin/offre/mass-update.
La requête cURL pour changer le statut de trois offres en Paused :
curl --request POST \N- --url https://api-rocketcompany.affise.com/3.0/admin/offer/mass-update \N- --header 'api- : 4sdf87fsdfd8723lkjhrn324' \N- --header 'content-type : application/x-www-form-urlencoded' \N- --data 'offer_id[0]=1441594' \N- --data 'offer_id[1]=1441528' \N- --data 'offer_id[2]=1441527' \N- --data status=suspended
Veuillez contacter l'équipe d'assistance à la clientèle d'Affise pour toutes les questions soulevées par le biais de l'e-mail : [email protected].