Introduction

L'API Postback est fournie par le Portail pour développeur de l'API Rakuten Advertising. Visiter le portail pour obtenir une liste complète des API que nous proposons.

Application

L'API Postback vous permet de recevoir des événements de transaction au fur et à mesure qu'ils sont traités dans notre système. Elle est conçue pour fournir des données similaires à celles de l'API d'événements, sauf que nous vous transmettons ces données afin que vous n’ayez pas besoin de les récupérer via l'API d'événements.

Vous pouvez utiliser l'API pour :

• Configurer un postback pour un ID publisher spécifique.
• Modifier l'URL du postback.
• Supprimer l'URL du postback.
• Désactiver ou activer le postback.

Fonctionnalité bêta

L'API Postback est actuellement en version bêta, car nous cherchons à obtenir les commentaires des utilisateurs pour l'améliorer. La fonctionnalité du postback ne sera pas affectée par les améliorations futures. Les améliorations n'affecteront que l'interaction de l'utilisateur avec l'API.

Accès

Vous pouvez consulter des instructions détaillées sur l'utilisation de l'API Postback dans le portail. Utilisez vos identifiants de connexion autableau de bord des publishers pour vous connecter.

Avant de commencer, vous devez disposer des éléments suivants :

• Une URL pour le postback. Cette URL est personnalisable, comme détaillé ci-dessous.
• Le jeton d'accès à l'API. Consultez les instructions pour récupérer un jeton d'accès à l'API.

En outre, votre compte d'utilisateur doit être associé à l'ID publisher qui implémente le postback.

Configurer l'URL d'un postback

L'API Postback peut prendre en charge des URL dynamiques, ce qui vous permet de personnaliser le résultat. L'URL de votre postback doit comporter :

1. L'URL de votre site.
2. Le champ is_event=<is_event>.
3. Les paramètres de tout autre champ que vous souhaitez inclure. Ceux-ci sont personnalisables ; consultez la section Champs personnalisables ci-dessous pour plus d'informations. Si vous incluez plusieurs paramètres, ceux-ci doivent être séparés par une esperluette (&).

Par exemple, si votre site web est https://www.my-pretty-postback-URL.com et que vous souhaitez inclure les champs transaction_date et sku_number, l'URL de votre postback sera la suivante :

https://www.my-pretty-postback-URL.com?is_event=<is_event>& transaction_date=<transaction_date>&sku_number=<sku_number>

Pour en savoir plus sur l'objectif du champ is_event=<is_event> et sur comment interpréter vos données, consultez le Guide sur les transactions de l'API d'événements sur le portail pour développeur.

Champs personnalisables

Les personnalisations suivantes sont autorisées :

• Renommer les noms de champs.
• Accepter uniquement certains champs.
• Réorganiser les champs.
• Utilisation de valeurs statiques.

Nous vous recommandons de consulter les Questions courantes sur l'API d'événements et le Guide sur les notifications/postback de l'API d'événements sur le portail pour développeur pour voir une liste des champs disponibles et des exemples de personnalisation de postback.

Exemples de demandes de personnalisation

• Exemple 1 : renommer u1 en unique_id
• Exemple 2 : n'inclure que les champs suivants :
  • transaction_date
  • sku_number
  • quantity
  • commissions
• Exemple 3 : n'inclure que les champs suivants et les renommer :
  • transaction_date
  • sku_number
  • quantity
  • commissions
  • Renommez u1 en unique_id

Dépannage

Si le point d'arrivée de votre postback reçoit des données incorrectes ou pas de données du tout, veuillez :

• Vous assurer que votre point d'arrivée respecte notre limite de temps de 400 ms. Notre serveur n'enverra pas de données si l'URL de votre point d'arrivée prend plus de temps que 400 ms pour répondre à la demande. Une seule tentative de connexion est effectuée. Les données ne sont pas renvoyées si une tentative de connexion est annulée ou échoue.
• Vérifiez que ces données existent en exécutant un Rapport sur les articles individuels avec le champ Member ID (u1). Notez que les données peuvent prendre jusqu'à quatre heures avant d'apparaître sur un rapport.
• Vous ne serez pas averti si votre postback est désactivé automatiquement. Nous vous recommandons d'utiliser l'appel de l'API de statut de point d'arrivée pour savoir si un postback est désactivé ou actif.

Vous trouverez également une liste de messages d'erreur spécifiques et leur signification dans les guides Portail pour développeur. Si vous rencontrez toujours des problèmes, contactez le service d'assistance à la clientèle en précisant les numéros de commande ou les dates auxquelles les données n'ont pas été reçues.