Référence de l'API Addrevenue

Notre API REST a été développée pour répondre aux besoins des affiliés et des annonceurs. Elle utilise OAuth 2.0 et vous pouvez générer manuellement un jeton d'API à vie dans notre interface utilisateur. Ce jeton porteur est ensuite envoyé comme en-tête d'autorisation.

URL de base de l'API

Tous les points de terminaison commencent par l'URL de base :

https://addrevenue.io/api/v2

Veillez à toujours utiliser le protocole HTTPS.

Authentification

Pour générer une API, connectez-vous à Addrevenue, cliquez sur « Jetons d'API », puis sur « Générer un nouveau jeton d'API ». Cela créera un jeton API unique et permanent pour l'utilisateur connecté, autorisant le client à agir en son nom.

Le jeton doit ensuite être envoyé comme jeton Bearer dans toutes les requêtes adressées aux points de terminaison de l'API.

Exemple d'en-tête :

Authorization: Bearer 1892cd44-c59c-42bf-9f1d-a5316ea695cc Content-type: application/json

Erreurs

L'envoi d'un jeton Bearer vide ou non valide entraînera l'une des erreurs http suivantes :

403 En-tête d'autorisation introuvable
Cela indique que l'en-tête d'autorisation est manquant ou mal formé, par exemple sans le « Bearer ». Chaîne.

403 Jeton non valide
L'en-tête est correctement formaté, mais le jeton API fourni n'existe pas.

403 Compte inactif
L'en-tête est correctement formaté et le jeton API fourni existe, mais il appartient à un compte inactif.

Réponses

Toutes les réponses sont au format JSON et contiennent le code http (identique à celui de l'en-tête de réponse), le nombre d'éléments de résultat et les résultats (un tableau d'éléments de résultat).

Exemple (raccourci) :

{ "http_code": 200, "count": 2, "results": [ { "id": 1000, "description": "Exemple de campagne A" }, { "id": 1001, "description": "Exemple de campagne B" } ]

Points de terminaison de l'API

Cette API étant encore en version bêta en cours de développement, nous avons reporté la documentation exacte du corps de réponse de tous les points de terminaison.

Annonceurs
Bannières
Campagnes
Canaux
Événements
Paiements
Produits
Flux de produits
Relations
Statistiques
Transactions

Paramètres de requête

En général, vous pouvez envoyer des paramètres de requête dans la chaîne de requête avec les mêmes noms que dans la réponse pour filtrer la requête. Par exemple, si vous souhaitez récupérer uniquement les clics pour l'ID de clic 6230fe5f0fc866.4851567a, la requête ressemblera à ceci : /events?type=Click&clickId=6230fe5f0fc866.4851567a.

Intervalles de dates

Pour certains points de terminaison, cette fonctionnalité permet de fournir des paramètres de requête d'intervalle de dates, comme pour les transactions et les événements. Ces informations sont fournies via fromDate et/ou toDate. Elles peuvent être utilisées ensemble pour définir un intervalle ou seulement l'une d'entre elles.

Obtenir des annonceurs

GET /advertisers

Si vous êtes authentifié en tant que compte affilié, la réponse inclut un tableau de tous les annonceurs actifs. Si un channelId est fourni, la réponse n'inclura que les annonceurs ayant un type de relation (actif, en attente ou rejeté). L'état de la relation sera renvoyé sous la forme relationStatus.

Si l'utilisateur est authentifié en tant que compte annonceur, la réponse inclut uniquement le compte annonceur authentifié lui-même.

Paramètres de la requête :

Paramètre	Description
channelId entier	Facultatif. Si un identifiant de chaîne est fourni, la réponse inclura uniquement les annonceurs ayant un lien avec la chaîne donnée.

Obtenir des bannières

GET /banners

Ce point de terminaison renvoie un tableau de tous les groupes de bannières et de leurs bannières.

Si l'utilisateur est authentifié en tant que compte affilié, la réponse inclut un tableau de tous les groupes de bannières et de leurs bannières pour tous les annonceurs. Si un identifiant de canal est fourni et qu'il existe une relation approuvée entre le canal et l'annonceur, un code de suivi pour chaque bannière sera inclus dans la réponse.

Si l'utilisateur est authentifié en tant que compte d'annonceur, la réponse inclut un tableau de tous les groupes de bannières et de leurs bannières pour cet annonceur.

Paramètres de la requête :

Paramètre	Description
Id de canal entier	Facultatif. Si un identifiant de chaîne est fourni, les codes de suivi de toutes les bannières seront inclus dans la réponse.

Obtenir les campagnes

GET /campaigns

Ce point de terminaison renvoie un tableau de toutes les campagnes (codes de réduction et offres).

Si l'utilisateur est authentifié en tant que compte affilié, la réponse inclut toutes les campagnes publiques actives de tous les annonceurs, ainsi que toutes les campagnes exclusives des chaînes appartenant à cet affilié spécifique. Si un paramètre de requête channelId est fourni, seules les campagnes des annonceurs dont la relation avec le canal est approuvée seront renvoyées et un trackingLink pour chaque campagne sera inclus dans la réponse.

Si l'annonceur est authentifié en tant que compte annonceur, la réponse inclut toutes les campagnes (actives et inactives, publiques et exclusives au canal) de cet annonceur.

Paramètres de la requête :

Facultatif. Si un identifiant de chaîne est fourni, seules les campagnes des annonceurs ayant des relations approuvées avec la chaîne seront incluses. Des liens de suivi spécifiques aux canaux pour toutes les campagnes seront inclus dans la réponse.

Paramètre	Description
channelId entier

Obtenir les canaux

GET /channels

Si l'utilisateur est authentifié en tant que compte affilié, la réponse inclut un tableau de tous les canaux appartenant au compte authentifié.

Si l'utilisateur est authentifié en tant que compte annonceur, un en-tête de réponse 403 Forbidden sera renvoyé.

Obtenir les événements

GET /events

Renvoie tous les événements de suivi du compte authentifié.

Obtenir les paiements

GET /payouts

Renvoie tous les paiements du compte affilié authentifié. Si le compte authentifié n'est pas un compte affilié, l'erreur 403 « Forbidden » est renvoyée.

Obtenir les produits

GET /products

Renvoie tous les produits du catalogue. La réponse est paginée.

Paramètres de la requête :

Paramètre	Description
limite entier	Facultatif. Nombre de produits dans la réponse. La valeur par défaut est 100. La valeur maximale est 1000.
offset entier	Facultatif. Le décalage de la pagination. La valeur par défaut est 0, ce qui permet d'obtenir la `limite` des premiers produits. En passant 1, les résultats `limit` suivants sont renvoyés.

Exemple :

/products?limit=50&offset=3

Obtenir les flux de produits

GET /productfeeds?channelId=xxxxxxx

Ce point de terminaison renvoie un tableau de tous les flux de produits pour le canal spécifié.

Si vous êtes authentifié en tant que compte annonceur, une réponse 403 « Forbidden » sera générée, car ce point de terminaison est réservé aux affiliés.

Paramètres de la requête :

Paramètre	Description
channelId entier	Obligatoire. L'ID de chaîne est obligatoire, car il sera inclus dans les URL de flux de produits générés.

Obtenir les relations

GET /relations

Renvoie toutes les relations entre les chaînes et les annonceurs pour le compte authentifié.

Obtenir les statistiques

GET /stats

Renvoie des statistiques agrégées telles que les impressions de bannières, les clics, les transactions, etc. pour le compte authentifié.

Paramètres de la requête :

Paramètre	Description
groupBy chaîne	Facultatif. Si ce paramètre est inclus, la réponse sera agrégée au niveau groupBy. Les options acceptées pour groupBy sont `date`, `annonceur`, `canal` et `programme`. Si ce paramètre n'est pas fourni, la réponse sera agrégée en un seul bloc. Pour regrouper selon plusieurs dimensions, vous pouvez utiliser une virgule comme délimiteur.

Obtenir les transactions

GET /transactions

Renvoie toutes les transactions du compte authentifié.

Paramètres de la requête :

Paramètre	Description
includeClicks entier	Facultatif. Si ce paramètre est inclus et défini sur 1, la réponse inclura également un tableau de tous les clics ayant précédé la transaction.

En développement !

Lorsque d'autres points de terminaison seront ajoutés, cette référence d'API sera mise à jour. Veuillez noter que cette API est en version bêta et que la documentation des réponses aux requêtes est reportée.

Journal des modifications

18/09/2024 : Modification des noms des paramètres de pagination : productsPerPage et selectedPage par limit et offset.

12/05/2022 : Ajout du nouveau point de terminaison /payouts permettant aux affiliés de récupérer tous les paiements.

28/04/2022 : Ajout du nouveau point de terminaison /productfeeds permettant aux affiliés de récupérer la liste de toutes les URL de flux de produits.

27/04/2022 : Ajout du nouveau point de terminaison /relations pour répertorier les relations entre les canaux et les annonceurs.

22/04/2022 : Ajout de la possibilité de regrouper les données /stats sur plusieurs canaux. Dimensions

21/04/2022 : Ajout de channelId comme paramètre de requête au point de terminaison /advertiser, afin de limiter la réponse aux annonceurs liés au canal donné.

20/04/2022 : Ajout du point de terminaison /stats pour obtenir des statistiques agrégées.

19/04/2022 : Ajout de la possibilité d'envoyer des réponses limitées à certains points de terminaison, tels que les transactions et les événements, en utilisant les paramètres de chaîne de requête fromDate et/ou toDate.

22/03/2022 : Lors de l'envoi de channelId au point de terminaison /campaigns, seules les campagnes des annonceurs ayant une relation approuvée avec le canal seront désormais affichées.

19/03/2022 : Ajout du paramètre de requête includeClicks au point de terminaison /transactions, afin d'inclure tous les clics précédents dans une Tableau.

18/03/2022 : Ajout de trackingLink dans la réponse du point de terminaison /campaigns, si le paramètre channelId est fourni.

18/03/2022 : Ajout de advertiserName dans la réponse du point de terminaison /campaigns.

18/03/2022 : Ajout de advertiserName dans la réponse du point de terminaison /banners.

Créer un compte

Choisissez le type de compte qui correspond le mieux à votre profil

Référence de l'API Addrevenue