Introdução

A Postback API é fornecida pelo Rakuten Advertising API Developer Portal. Visite o portal para obter uma lista completa das APIs que oferecemos.

Aplicação

A API Postback permite que você receba eventos de transação à medida que eles são processados em nosso sistema. Ela foi projetada para fornecer dados semelhantes à Events API, só que enviamos esses dados a você, para que não seja necessário buscá-los via Events API.

Você pode usar a API para:

• Configurar um postback para um ID específico de afiliado.
• Atualizar o URL de postback.
• Excluir o URL de postback.
• Desativar ou ativar um postback.

Funcionalidade Beta

A Postback API está atualmente na versão beta, pois estamos buscando feedback dos usuários para aprimoramentos. A funcionalidade do postback não será afetada por nenhum aprimoramento futuro. Os aprimoramentos afetarão apenas a interação do usuário com a API.

Acesso

Você pode ver instruções detalhadas sobre o uso da API Postback no portal. Use suas credenciais de login noPainel do Afiliado para entrar.

Antes de começar, você precisa dos seguintes itens:

• Um URL para o postback. Este URL é personalizável, conforme detalhado abaixo.
• O token de acesso à API. Veja as instruções para recuperar um token de acesso à API.

Além disso, sua conta de usuário deve estar associada ao ID afiliado que implementa o postback.

Configuração de um URL de postback

A API Postback pode suportar URLs dinâmicos, permitindo a personalização da saída. Seu URL de postback deve incluir:

1. O URL do seu site.
2. O campo is_event=<is_event>.
3. Parâmetros para quaisquer outros campos que queira incluir. Esses campos são personalizáveis; consulte a seção Campos Personalizáveis abaixo para mais detalhes. Para a inclusão de vários parâmetros, separe-os com um E comercial (&).

Por exemplo, se o seu site for https://www.my-pretty-postback-URL.com e você quiser incluir os campos transaction_date e sku_number, sua URL de postback será:

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

Para obter mais informações sobre a finalidade do campo is_event=<is_event> e como interpretar seus dados, consulte o guia de Transações da Events API no Developer Portal.

Campos customizáveis

As seguintes personalizações são permitidas:

• Renomear nomes dos campos.
• Receber apenas alguns campos.
• Reordenar os campos.
• Usando valores estáticos.

Recomendamos que você revise as Perguntas Comuns da Events API e o Guia de Push/Postback da Events API no Developer Portal para obter uma lista de campos disponíveis e exemplos de personalização de postback.

Exemplos de Pedidos de Personalização

• Exemplo 1: renomear u1 para unique_id
• Exemplo 2: inclua apenas os seguintes campos:
  • transaction_date
  • sku_number
  • quantity
  • commissions
• Exemplo 3: inclua apenas os seguintes campos e renomeie os seguintes:
  • transaction_date
  • sku_number
  • quantity
  • commissions
  • Renomeie u1 para unique_id

Solucionando Problemas

Se o seu terminal de postback estiver recebendo dados incorretos ou nenhum dado, por favor:

• Confirme se seu endpoint atende ao nosso limite de tempo de 400ms. Nosso servidor não enviará dados se o URL do seu endpoint demorar mais do que 400ms para responder ao pedido. É feita apenas uma tentativa de conexão. Os dados não são reenviados se uma tentativa de conexão for cancelada ou falhar.
• Verifique se os dados existem executando um Relatório de Itens Individuais com o campo Member ID (u1). Note que pode levar até quatro horas para que os dados apareçam em um relatório.
• Você não será notificado se o postback for desativado automaticamente. Recomendamos que você use a chamada da API de status do endpoint para verificar se um postback está desativado ou ativo.

Também fornecemos uma lista de mensagens de erro específicas e seus significados nos Guias do Developer Portal. Se ainda estiver enfrentando problemas, entre em contato com o Suporte ao Cliente com IDs de pedidos específicos ou datas em que os dados não foram recebidos.