Funzionamento di Visibilità integrata avanzata
Panoramica sul webhook di Visibilità integrata avanzata
Il webhook di Visibilità integrata avanzata consente a FedEx di inviare in modo sicuro i dati degli eventi di monitoraggio in tempo quasi reale a un URL di destinazione specificato per le spedizioni collegate a designati Codici Cliente FedEx.
Per utilizzare questa funzionalità, un amministratore FedEx o un amministratore DI deve creare un progetto webhook di Visibilità integrata avanzata.
Opzioni di navigazione
Potete accedere alla pagina Webhook di Visibilità integrata avanzata in due modi:
Opzione 1: tramite I miei progetti
- Passate a I miei progetti nel pannello di navigazione a sinistra.
- Cliccate sulla scheda Webhook.
Opzione 2: tramite il catalogo API
- Accedete al Catalogo API dal pannello di navigazione a sinistra.
- Usate la barra di ricerca per trovare la Visibilità integrata avanzata o selezionatela dalla sezione FILTRI.
- Nella scheda Webhook, scegliete una delle seguenti opzioni:
- Cliccate su Documenti → poi cliccate + Gestisci webhook
Visualizzazione di un progetto di Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata
1. Accesso e configurazione personale di FedEx
- Un amministratore FedEx o un Referente Commerciale FedEx avvierà il processo di configurazione.
- Il profilo dell'organizzazione viene creato da un amministratore designato per conto dei clienti CSP.
- Un Codice Cliente di fatturazione idoneo con sede negli Stati Uniti viene aggiunto a livello di organizzazione dall'amministratore per conto del cliente.
- L'amministratore che esegue questa configurazione deve avere le autorizzazioni appropriate per gestire le configurazioni a livello organizzativo.
2. Visualizzate il flusso di lavoro per la sottoscrizione dei numeri di monitoraggio
2.1 Visualizzate la sottoscrizione
- Una volta che un amministratore o un rappresentante FedEx crea un progetto, gli utenti possono visualizzare il progetto associato di sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata nel proprio dashboard.
2. Visualizzate le funzionalità
- Gli utenti possono esplorare le funzionalità disponibili associate al progetto di sottoscrizione per una migliore comprensione e un migliore utilizzo.
Descrizioni delle funzionalità
| Nome del campo | Descrizione |
|---|---|
| Prova di consegna | Conferma che una spedizione è stata consegnata correttamente. Include:
|
| Consegna stimata | Aiuta i destinatari a pianificare fornendo:
|
| Eventi di monitoraggio | Consente di selezionare una o più categorie di eventi per ricevere notifiche:
|
Nella pagina Dettagli, verranno visualizzate le seguenti informazioni:
| Nome del campo | Descrizione |
|---|---|
| Nome progetto webhook | Un nome univoco e non vuoto per il progetto webhook. Un nome suggerito viene compilato automaticamente ma può essere modificato. Questo nome non deve essere ripetuto in nessun altro webhook. |
| URL di destinazione | L'endpoint HTTPS sicuro a cui FedEx invierà i dati relativi agli eventi di monitoraggio. Requisiti:
|
| Token di sicurezza | Un segreto condiviso utilizzato per autenticare e convalidare le risposte del webhook tramite HMAC. Requisiti:
|
| Lingua del carico utile (Paese) | Selezionate la lingua desiderata per la traduzione dei dati di monitoraggio dall'elenco a discesa. |
| Tipo monitoraggio | Scegliete come devono essere forniti i dati di monitoraggio:
|
| Indirizzo email | Indicate un indirizzo email valido per ricevere le notifiche. |
| Lingua dell'email (Paese) | Selezionate la lingua in cui preferite ricevere le notifiche tramite email. Nota: sono supportate solo le lingue dall'area geografica degli Stati Uniti (ad es.: en-US, es-US). |
Procedura dettagliata
4. Create un progetto di sottoscrizione
- Seguite i passaggi della sezione precedente o fate riferimento alla Guida introduttiva.
5. Generate un token OAuth
- Per effettuare chiamate API è necessario un token OAuth.
- Usate l'Authorization API per generare il token.
- Consultate la documentazione Authorization API nel Catalogo API per i passaggi dettagliati.
6. Accedete alla documentazione API
- Nel menu di navigazione a sinistra, cliccate su Dettagli del progetto.
- Nella scheda Chiavi di produzione, scorrete fino a trovare la documentazione dell'API Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata.
Panoramica endpoint API
| Endpoint | Scopo |
|---|---|
| Associazione del numero di monitoraggio | Consente di aggiungere o rimuovere numeri di monitoraggio da una sottoscrizione al webhook. Si tratta di un processo asincrono. Nella risposta viene restituito un ID processo. |
| Dettagli del processo dei numeri di monitoraggio | Fornisce dettagli per un ID processo specifico, ad esempio quanti numeri di monitoraggio FedEx sono stati aggiunti correttamente o sono ancora in fase di elaborazione. |
| Stato dei processi dei numeri di monitoraggio | Restituisce un riepilogo di tutti i processi attualmente in fase di elaborazione. |
Utilizzate il token OAuth della Fase 2 con l'endpoint di associazione del numero di monitoraggio per aggiungere numeri di monitoraggio al webhook.
Regole di convalida
- Il nome del webhook deve essere univoco.
- L'URL di destinazione deve essere in formato sintattico standardizzato.
- Tutti i campi obbligatori devono essere compilati.
- Deve essere associato almeno un Codice Cliente FedEx valido.
Risultati della convalida
| Stato | Dettagli |
|---|---|
| Operazione riuscita | Viene mostrato un messaggio di conferma: "<> creato correttamente. L'applicazione delle modifiche può richiedere fino a 10 minuti." |
| Operazione non riuscita | Se FedEx riceve una risposta diversa da 200 (OK) o 202 (Accettato), la convalida dell'URL di destinazione del webhook verrà considerata non riuscita. |
