Introducción

El Postback API (interfaz de programación de aplicaciones) es proporcionado por el Developer Portal de API (interfaz de programación de aplicaciones) Rakuten Advertising. Visite el portal para obtener una lista completa de las API que ofrecemos.

Aplicación

La función Postback API (interfaz de programación de aplicaciones) le permite recibir eventos de transacción a medida que se procesan en nuestro sistema. Está diseñado para proporcionar datos similares a los de Events API, con la diferencia de que nosotros se los enviamos para que usted no tenga que buscarlos a través de Events API.

Puede utilizar la API (interfaz de programación de aplicaciones) para:

• Configure un postback para un ID específico de publicador.
• Actualizar la URL del Postback.
• Eliminar la URL del Postback.
• Desactivar o activar un Postback.

Funcionalidad beta

La Postback API (interfaz de programación de aplicaciones) se encuentra actualmente en fase beta, ya que estamos esperando los comentarios de los usuarios para introducir mejoras. La funcionalidad de la Postback API no se verá afectada con futuras mejoras. Las mejoras solo afectarán a la interacción del usuario con la API (interfaz de programación de aplicaciones).

Acceso

Puede consultar instrucciones detalladas sobre el uso de Postback API (interfaz de programación de aplicaciones) en el portal. Utilice sus credenciales de acceso de Publisher Dashboard para iniciar la sesión.

Antes de empezar, necesita lo siguiente:

• Una URL para el postback. Esta URL se puede personalizar, como se explica más adelante.
• El token de acceso API (interfaz de programación de aplicaciones) . Lea las instrucciones para recuperar un token de acceso de API (interfaz de programación de aplicaciones).

Además, su cuenta de usuario debe estar asociada al identificador del publicador que implementa el postback.

Configuración de una URL de Postback

La Postback API (interfaz de programación de aplicaciones) puede admitir URL dinámicas, lo que le permite personalizar la salida. La URL de Postback debe incluir:

1. La URL de su sitio web.
2. El campo is_event=<is_event>
3. Los parámetros para cualquier otro campo que desee incluir. Son personalizables; consulte la sección Campos personalizables a continuación para obtener más información. Si incluye varios parámetros, estos deberán ir separados por un «ampersand» (&).

Por ejemplo, si su sitio web es https://www.my-pretty-postback-URL.com y desea incluir los campos transaction_date y sku_number, su URL de Postback será:

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

Para más información sobre la finalidad del campo is_event=<is_event> y cómo interpretar sus datos, consulte la guía de transacciones de la Events API en el Developer Portal.

Campos personalizables

Se permiten las siguientes personalizaciones:

• Cambiar el nombre de los campos.
• Recibir solo determinados campos.
• Reordenar los campos.
• Utilizar valores estáticos.

Le recomendamos que consulte las preguntas frecuentes de la Events API y la guía Push/Postback de la Events API en el Developer Portal para ver una lista de los campos disponibles y los ejemplos de personalización del Postback.

Ejemplos de solicitudes de personalización

• Ejemplo 1: cambiar el nombre de «u1» a «unique_id»
• Ejemplo 2: incluir solo los siguientes campos:
  • transaction_date
  • sku_number
  • quantity
  • commissions
• Ejemplo 3: incluir solo los siguientes campos y cambiar el nombre de los siguientes:
  • transaction_date
  • sku_number
  • quantity
  • commissions
  • Cambie el no mbre de "u1" p or "unique_id"

Resolución de problemas

Si el terminal del Postback recibe datos incorrectos o no recibe ningún dato, haga lo siguiente:

• Confirme que su terminal cumple nuestro límite de tiempo de espera de 400 ms. Nuestro servidor no enviará datos si la URL de su terminal tarda más de 400 ms en responder a la solicitud. Solo se realiza un intento de conexión. Los datos no se vuelven a enviar si se anula o fracasa un intento de conexión.
• Compruebe que los datos existen ejecutando un Individual Item Report con el campo ID de miembro (u1). Tenga en cuenta que los datos pueden tardar hasta cuatro horas en aparecer en un informe.
• No recibirá ninguna notificación si su Postback se desactiva automáticamente. Le recomendamos que utilice la llamada de estado del terminal API (interfaz de programación de aplicaciones) para comprobar si un postback está desactivado o activo.

Además, ofrecemos una lista de mensajes de error específicos con su significado en las guías Developer Porta l. Si sigue teniendo problemas, póngase en contacto con el servicio de atención al cliente e indíquenos el número de pedido o las fechas concretas en las que no se recibieron los datos.