Introduzione

Postback API è fornita dall' API Developer Portal di Rakuten Advertising. Visiti il portale per un elenco completo delle API che offriamo.

Applicazione

Postback API le permette di ricevere gli eventi di transazione mentre vengono elaborati nel nostro sistema. È stata progettata per fornire dati simili a quelli dell'Events API, con la differenza che questi dati vengono inviati all'utente in modo da non doverli recuperare tramite Events API

Può utilizzare l'API per:

• Impostare un postback per uno specifico ID editore.
• Aggiornare l'URL di postback.
• Cancellare l'URL di postback.
• Disabilitare o abilitare un postback.

Funzionalità beta

La Postback API è attualmente in fase beta perché abbiamo bisogno del feedback degli utenti per apportare miglioramenti. La funzionalità del postback non sarà influenzata dagli eventuali miglioramenti futuri. I miglioramenti riguarderanno solo l'interazione dell'utente con l'API.

Accesso

Può visualizzare istruzioni dettagliate sull'utilizzo dell'API Postback nel portale. Utilizzi le sue credenziali di accesso a Publisher Dashboard per accedere.

Prima di iniziare, ha bisogno di quanto segue:

• Un URL per il postback. Questo URL è personalizzabile, come descritto di seguito.
• Il token di accesso all'API. Visualizzare le istruzioni per recuperare un token di accesso API.

Inoltre, il suo account utente deve essere associato all'ID publisher che implementa il postback.

Configurare un URL di postback

La Postback API può supportare URL dinamici, consentendole di personalizzare l'uscita. Il suo URL di postback dovrebbe includere:

1. L'URL del suo sito.
2. Il campo is_event=<is_event>
3. Parametri per qualsiasi altro campo che desidera includere. Questi sono personalizzabili; veda la sezione "Campi personalizzabili" qui sotto per maggiori dettagli. Se include diversi parametri, deve separarli con una e commerciale (&).

Ad esempio, se il suo sito web è https://www.my-pretty-postback-URL.com e desidera includere i campi transaction_date e sku_number, il suo URL di postback sarà:

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

Per maggiori informazioni sullo scopo del campo is_event=<is_event> e su come interpretare i suoi dati, consulti la guida Events API Transactions nel Developer Portal.

Campi personalizzabili

Sono consentite le seguenti personalizzazioni:

• Rinominare i nomi dei campi.
• Ricevere solo determinati campi.
• Riordinare i campi.
• Utilizzare valori statici.

Le consigliamo di consultare le Domande comuni sulla Events API e la Guida Events API Push/Postback nel Developer Portal per vedere un elenco dei campi disponibili ed esempi di personalizzazione del postback.

Esempi di richieste di personalizzazione

• Esempio 1: Rinominare "u1" in "unique_id".
• Esempio 2: Includere solo i seguenti campi:
  • transaction_date
  • sku_number
  • quantity
  • commissions
• Esempio 3: Includere solo i seguenti campi e rinominare i seguenti:
  • transaction_date
  • sku_number
  • quantity
  • commissions
  • Rinominare "u1" in "unique_id".

Soluzione dei problemi

Se l'endpoint del suo postback riceve dati non corretti o non ne riceve affatto, la preghiamo di:

• Confermare che l'endpoint rispetti il nostro limite di timeout di 400 ms. Il nostro server non invierà i dati se il suo URL di endpoint impiega più di 400 ms per rispondere alla richiesta. Viene effettuato un solo tentativo di connessione. I dati non vengono inviati di nuovo se il tentativo di connessione viene annullato o fallisce.
• Verifichi che i dati esistano eseguendo un Individual Item Report col campo Member ID (u1). Si noti che possono essere necessarie fino a quattro ore per mostrare i dati in un rapporto.
• Non riceverà alcuna notifica se il postback viene disabilitato automaticamente. Le consigliamo di utilizzare la chiamata API endpoint status per verificare se un postback è disabilitato o attivo.

Forniamo anche un elenco di messaggi di errore specifici e il loro significato nelle Guide di Developer Portal. Se i problemi persistono, si rivolga all' Assistenza clienti indicando gli ID degli ordini o le date in cui i dati non sono stati ricevuti.