Fedex Logo

CREA UN
WEBHOOK GESTISCI WEBHOOK

Funzionamento di Visibilità integrata avanzata

Il webhook di Visibilità Integrata Avanzata consente a FedEx di inviare aggiornamenti sicuri e quasi in tempo reale sul monitoraggio a un URL specifico. Questi aggiornamenti riguardano le spedizioni collegate a uno o più Codici Cliente FedEx. Per utilizzare questa funzionalità, è necessario creare un progetto webhook di Visibilità integrata avanzata.

Come accedere alla pagina di Visibilità integrata avanzata

Potete accedere alla configurazione Visibilità integrata avanzata in due modi:

Opzione 1: tramite I miei progetti

    1. Passate a I miei progetti nel pannello di navigazione a sinistra.

    2. Cliccate sulla scheda Webhook.

    3. Selezionate +CREA UN PROGETTO WEBHOOK.

Opzione 2: tramite il catalogo API

    1. Aprite il Catalogo API dal pannello di navigazione a sinistra.

    2. Cercate la Visibilità integrata avanzata.

    3. Usate il filtro WEBHOOK per trovare la scheda corretta.

    4. Nella scheda:

  •  Cliccate su Panoramica, poi sul pulsante Documentazione e scegliete +CREA UN PROGETTO WEBHOOK.
  •  Oppure passate a DOCUMENTI e cliccate su +CREA UN PROGETTO WEBHOOK.

 

Passaggio 1: selezionare il tipo di azienda

Cliccate su +CREA UN PROGETTO e scegliete il tipo di azienda dal menu a tendina:

    1. Spedisce con FedEx e ha bisogno di integrare il webhook FedEx nel proprio sistema.

    2. Vende o fornisce una soluzione software che utilizza dati FedEx e non è un FedEx Compatible Provider.

    3. È un FedEx Compatible Provider certificato.

 

Quindi, selezionate Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata come tipo di sottoscrizione.

Creare una Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata

Potete configurare una Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata per ricevere aggiornamenti sicuri e quasi in tempo reale per uno o più numeri di monitoraggio FedEx. Questi aggiornamenti vengono inviati a un URL di destinazione specificato da voi.

 

Passaggi per creare la sottoscrizione

Il processo prevede quattro passaggi principali:

    1. Configurare il progetto

    2. Inserire i dettagli del progetto

    3. Confermare i dettagli e accettare i termini

    4. Aggiungere i numeri di monitoraggio

 

Istruzioni passo-passo

    1. Nella pagina dedicata alla configurazione di un webhook:

         Controllate il Codice Cliente di fatturazione

         Verrà visualizzato il Codice Cliente di fatturazione predefinito dell'organizzazione.

         Per modificarlo:

  •  Cliccate su AGGIUNGERE UN CODICE CLIENTE DI FATTURAZIONE ALL'ORGANIZZAZIONE (se avete un solo Codice Cliente) oppure
  •  Cliccate su SELEZIONARE UN ALTRO CODICE CLIENTE DI FATTURAZIONE (se esistono più Codici Cliente).

 

Nota: per i dettagli sui prezzi, visitate la pagina Panoramica sulla Visibilità integrata avanzata.

 

2. Selezionare le funzionalità

  •  Scegliete le funzionalità di cui avete bisogno.
  •  Cliccate su Avanti per continuare.

Suggerimento: per saperne di più su ogni funzionalità, cliccate sull'icona di aiuto (?) accanto.

Descrizioni delle funzionalità

Nome del campo Descrizione
Prova di consegna Conferma che una spedizione è stata consegnata correttamente. Include:
  • Fotografia della prova di consegna (PPODA): 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:
  • Spedire
  • In transito
  • Consegna
  • Eccezioni

 

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 uno dei relativi sottodomini
  • Può essere riutilizzato in più webhook
Per maggiori dettagli, consultate la sezione Regole aziendali e best practice.
Token di sicurezza Un segreto condiviso utilizzato per autenticare e convalidare le risposte del webhook tramite HMAC.
Requisiti:
  • 26-100 caratteri
  • Deve includere almeno 1 carattere maiuscolo, 1 minuscolo e 1 carattere 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 devono essere forniti 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).

3. Nella pagina Confermare i dettagli:

  •  Esaminate i dettagli del vostro progetto webhook.
  •  Leggete e accettate i Termini e Condizioni.
  •  Cliccate su Crea per finalizzare la configurazione del progetto webhook.

4. Una volta che la richiesta è stata inviata correttamente:

  •  FedEx creerà un nuovo progetto Webhook.
  •  Riceverete le chiavi di produzione per l'API di Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata.
  •  Potete usare questa API per associare i numeri di monitoraggio al vostro progetto.

Per saperne di più, consultate la pagina della documentazione dell'API di Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata.

Come aggiungere un numero di monitoraggio a un webhook

Per aggiungere un numero di monitoraggio alla vostra sottoscrizione al webhook usando l'API di Sottoscrizione dei numeri di monitoraggio alla Visibilità integrata avanzata, attenetevi ai passaggi seguenti:

 

Procedura dettagliata

1. Create un progetto di sottoscrizione

· Seguite i passaggi della sezione precedente o fate riferimento alla Guida introduttiva.

2. 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.

3. 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.
CLOSE

Response

Copy