Panoramica
Il webhook di Visibilità integrata avanzata consente a FedEx di inviare dati sugli eventi di monitoraggio protetti quasi in tempo reale a un URL di destinazione specificato per le spedizioni associate a uno o più Codici Cliente FedEx. Potete creare un progetto webhook per accedere a questa funzionalità tramite il FedEx Developer Portal.
Percorsi di navigazione
Potete accedere alla pagina di creazione del webhook tramite una delle seguenti modalità:
- Tramite I miei progetti: Pannello di navigazione a sinistra → scheda Webhook → +CREA UN PROGETTO Webhook
- Tramite Catalogo API:
- Pannello di navigazione a sinistra → Catalogo API
- Cercate o filtrate per Visibilità integrata avanzata
- Panoramica → Cliccate su Documentazione → Nella Console Sandbox, cliccate su +CREA UN PROGETTO
- Documenti → Cliccate su +CREA UN WEBHOOK
Passaggi per la creazione di un webhook
Passaggio 1: selezionare il tipo di azienda
Cliccate su +CREA UN PROGETTO e scegliete il tipo di azienda dal menu a tendina:
- Spedisce con FedEx e ha bisogno di integrare il webhook FedEx nel proprio sistema.
- Vende o fornisce una soluzione software che utilizza dati FedEx e non è un FedEx Compatible Provider.
- È un FedEx Compatible Provider certificato.
Nota: attualmente la soluzione webhook Visibilità integrata avanzata FedEx non è disponibile per questa opzione. In qualità di membri del programma FedEx Compatible, se desiderate accedere a Visibilità integrata di base o ad altre soluzioni di integrazione FedEx, contattate il manager del canale. Se non sapete chi è il manager del canale, contattate l'amministratore aziendale.
Quindi, selezionate Sottoscrizione dei Codici Cliente alla Visibilità integrata avanzata come tipo di sottoscrizione.
Create una Sottoscrizione dei Codici Cliente alla Visibilità integrata avanzata
Il processo di creazione prevede quattro passaggi chiave:
Passaggio 1: abilitazione della Sottoscrizione dei Codici Cliente alla Visibilità integrata avanzata
Questo passaggio è gestito da un Amministratore FedEx o da un Referente commerciale FedEx su richiesta di clienti terzi.
- Documento MNDA: l'amministratore FedEx o il Referente Commerciale FedEx raccoglierà l'Accordo di Non Divulgazione Reciproca (MNDA) insieme a un elenco di Codici Cliente della prima parte e del mittente.
Nota: durante questo caricamento sono consentiti Codici Cliente duplicati associati ad altre organizzazioni.
- Se applicabile, i prezzi personalizzati saranno abilitati a livello organizzativo.
Nota: questa funzionalità non è inclusa nell'esperienza di luglio.
Passaggio 2: + Crea progetto
Nella pagina Selezionate il/i prodotto/i:
- Cliccate su Visibilità integrata avanzata – Codice Cliente e quindi cliccate su Avanti.
- Selezionate i Codici Cliente di fatturazione, accettate i termini di pagamento e cliccate su Avanti.
È necessario aggiungere almeno un Codice Cliente di fatturazione.
Nella pagina Confermare i dettagli:
- Rivedete le informazioni sul progetto.
- Accettate Termini e Condizioni.
- Se si applicano i prezzi personalizzati, il documento correlato verrà visualizzato automaticamente.
Una volta completata la creazione, verrà visualizzato un messaggio di conferma:
"Il prodotto è stato aggiunto correttamente a 'I miei progetti'."
Passaggio 3: Panoramica del progetto – Processo di attivazione della chiave API
- Nella pagina Panoramica del progetto, nella scheda Chiavi API della sezione API, lo stato di produzione della sottoscrizione verrà inizialmente visualizzato come "Disabilitato".
- Un amministratore o un rappresentante FedEx abiliterà il prodotto su richiesta.
- Una volta abilitata, la scheda Chiave di produzione diventerà accessibile e lo stato della produzione verrà aggiornato a "In attesa di conferma".
- Dopo l'attivazione finale da parte dell'amministratore o del rappresentante FedEx, lo stato della produzione verrà visualizzato come "Abilitato."
Passaggio 4: Panoramica del progetto – Configurare il webhook
- Passate alla pagina Panoramica del progetto.
- Selezionate la scheda Webhook.
- Cliccate sul pulsante + Configura Webhook per iniziare la configurazione del webhook. Verrete reindirizzati alla scheda Webhook.
Descrizioni delle funzionalità
| Nome del campo | Descrizione |
|---|---|
| Prova di consegna | Conferma che una spedizione è stata consegnata correttamente. Include: Fotografia della prova di consegna (PPOD): fornisce una foto che mostra il luogo esatto di consegna. Prova di consegna firmata (SPOD): fornisce un'immagine della firma del destinatario, nome, data di consegna, ora e luogo. |
| Consegna stimata | Aiuta i destinatari a pianificare fornendo: Data di consegna stimata (EDD) Finestra oraria di consegna stimata (EDTW) |
| Eventi di monitoraggio | Consente di selezionare una o più categorie di eventi per ricevere notifiche: Spedizione In transito Consegna Eccezioni Opzioni di consegna personalizzate |
| Filtro basato sugli eventi | Filtra le risposte dei webhook da includere: Spedizioni in import Spedizioni in export Spedizioni di terzi |
2. Nella pagina Inserire dettagli, fornite 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: Deve essere valido e funzionante Deve seguire una sintassi standardizzata Non deve includere fedex.com o i suoi sottodomini Può essere riutilizzato in più webhook Deve fare riferimento alla sezione Regole aziendali e best practice per maggiori dettagli. |
| Token di sicurezza | Un segreto condiviso utilizzato per autenticare e convalidare le risposte del webhook tramite HMAC. Requisiti: Da 26 a 100 caratteri Deve includere almeno 1 carattere maiuscolo, 1 minuscolo e 1 numerico Può essere riutilizzato in più webhook |
| Lingua del carico utile (Paese) | Selezionate la lingua desiderata per la traduzione dei dati di monitoraggio dall'elenco a discesa. |
| Tipo monitoraggio | Scegliete come inviare i dati di monitoraggio: Monitoraggio dettagliato - Intera cronologia degli eventi Monitoraggio specifico dell'evento – Solo l'evento più recente |
| 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). |
Passaggio 3: scegliere i Codici Cliente di spedizione
Nella pagina Scegliere i Codici Cliente della spedizione:
Selezionate uno o più Codici Cliente FedEx da associare al progetto webhook.
Note
Verranno visualizzati solo i Codici Cliente non già associati ad altri webhook.
Per procedere è necessario associare almeno un Codice Cliente.
È possibile aggiungere un massimo di 100 Codici Cliente utilizzando l'interfaccia utente del webhook.
Per associare più di 100 Codici Cliente, usate l'API webhook.
Contattate il servizio clienti FedEx o l'Help Desk per richiedere l'accesso API.
Passaggio 4: confermare i dettagli e creare
Nella pagina Confermare i dettagli:
1. Rivedete tutte le informazioni che avete inserito per il progetto webhook.
2. Selezionate la casella per accettare i termini e condizioni.
3. Cliccate su Crea per finalizzare la configurazione del webhook.
Una volta inviato correttamente, il webhook verrà creato con un ID di sottoscrizione generato dal sistema e verrà impostato sullo stato Attivo.
Regole di convalida
Requisiti generali:
Il nome del webhook deve essere univoco.
L'URL di destinazione deve seguire un formato sintattico standardizzato (HTTPS sicuro, non fedex.com o i suoi sottodomini).
Tutti i campi obbligatori devono essere compilati; nessun campo obbligatorio deve essere lasciato vuoto.
Almeno un Codice Cliente di spedizione FedEx valido deve essere associato al webhook.
Convalida riuscita:
Se il webhook viene creato correttamente, il cliente riceverà un messaggio di conferma:
<<Webhook name>> creato correttamente. L'applicazione delle modifiche può richiedere fino a 10 minuti.
Convalida non riuscita:
Se FedEx riceve una risposta diversa da HTTP 200 (OK) o 202 (Accettato) dall'URL di destinazione, la convalida del webhook verrà considerata non riuscita.
