Primi passi¶
Fase 1: Esporre un endpoint sul proprio server¶
Le notifiche sono inviate come richieste HTTP a un endpoint sul vostro server. Per ricevere le notifiche è necessario quanto segue: - Un web server endpoint che possa inviare una richiesta HTTP(s) POST all’URL del webhook fornito - Il tipo di supporto della richiesta sarà impostato su application/json e viene comunicato nel Content-Type-header - L’evento viene inviato nel corpo della richiesta come stringa JSON.
I pattern dell’url del webhook devono usare il protocollo HTTPS, possono includere ${eventId} che sarà sostituito dall’id dell’evento quando sarà chiamato il webhook.
Esempi di URL del webhook
Per l’autenticazione di base consigliamo di fornire una chiave API.
Esempi di chiave API
- a9uj2ofd
- doordonotthereisnotry
- passonwhatyouhavelearned
Nota:
Se la chiave API configurata comprende il prefisso "Basic", sarà utilizzato lo schema basico di autenticazione e la chiave API sarà inviata nell’header HTTP "Autorizzazione".
In caso contrario, la chiave API sarà inviata nell’header HTTP "x-api-key" (situazione tipica per webhook dell’infrastruttura AWS).
Esempio di header HTTP
- Se la chiave API è "A9uj2ofd" allora verrà inviato l’header HTTP
x-api-key: A9uj2ofdquando viene chiamato il webhook. - se la chiave API è "Basic A9uj2ofd", sarà inviato l’header HTTP
Autorizzazione Basic A9uj2ofd
Fase 2: Impostare un URL del webhook e una chiave API nel tool CR interno¶
Inviare il webhook a partner-care@zalando.de e il team configurerà l’OEA entro 24 ore.
Fase 3: Accettare le notifiche¶
Per garantire che il proprio server accetti le notifiche nel modo corretto, è necessario confermare il ricevimento di ogni tipo di notifica con una risposta [200]. Se non riceviamo una risposta entro 10 secondi, ad esempio perché il vostro server è inaccessibile, tutte le notifiche verso il vostro endpoint saranno messe in coda e si farà un nuovo tentativo di invio. Maggiori informazioni sono disponibili qui.
Quando il vostro server riceve una notifica:
- Verificare che la chiave API sia inclusa nella notifica. Questo serve a confermare che la notifica è stata inviata da Connected Retail e non ha subito modifiche durante la trasmissione.
- Salvare la notifica nel proprio database.
- Confermare la notifica con la risposta seguente: [200]
- Applicare la propria logica di business: Confermare il ricevimento della notifica prima di applicare qualsiasi espressione logica di business perché in caso contrario un’interruzione nella vostra business logic potrebbe impedire a importanti aggiornamenti di raggiungere il vostro sistema.
Fase 4: Collaudo e go live¶
Dopo che la configurazione è stata completata dal team CR, inizierete a ricevere gli eventi in maniera quasi immediata. Verificare gli eventi per un periodo di 2 giorni prima di applicare qualsiasi business logic perché in caso contrario un’interruzione nella vostra business logic potrebbe impedire a importanti aggiornamenti di raggiungere il vostro sistema.