Prezentare generală
Webhookul Advanced Integrated Visibility permite FedEx să transmită aproape în timp real, date securizate privind evenimentele de monitorizare către un URL de destinație specificat pentru expedierile asociate cu unul sau mai multe numere de cont FedEx. Puteți crea un proiect webhook pentru a accesa această funcționalitate prin intermediul FedEx Developer Portal.
Căi de navigare
Puteți accesa pagina de creare a webhookului prin oricare dintre următoarele metode:
- Prin Proiectele mele: Panoul de navigare din stânga → fila Webhookuri → +CREAȚI UN PROIECT WEBHOOK
- Prin intermediul catalogului de interfețe API:
- Panoul de navigare din stânga → Catalog de interfețe API
- Căutați sau filtrați după Advanced Integrated Visibility
- Prezentare generală → Fă clic pe Documentați → În Consolă mediu de testare, faceți clic pe +CREAȚI UN PROIECT
- Documente → Faceți clic pe +CREAȚI UN WEBHOOK
Pașii pentru crearea webhookului
Pasul 1: Selectați tipul de companie
Apăsați pe +CREAȚI UN PROIECT și alegeți tipul companiei dvs. din meniul derulant:
- Expediază cu FedEx și are nevoie să integreze webhookul FedEx în propriul sistem.
- Vinde sau furnizează o soluție software care utilizează date FedEx și nu este furnizor FedEx Compatible certificat.
- Este un furnizor FedEx Compatible certificat.
Notă: în prezent, soluția FedEx Advanced Integrated Visibility nu este disponibilă pentru această opțiune. În calitate de membru al programului FedEx Compatible, dacă doriți să accesați Basic Integrated Visibility sau alte soluții de integrare FedEx, vă rugăm să contactați managerul de canal. Dacă nu știți cine este managerul de canal, contactați administratorul companiei.
Apoi, selectați Înregistrare pe baza numărului de cont Advanced Integrated Visibility ca tip de înregistrare.
Crearea unei înregistrări de număr de cont Advanced Integrated Visibility
Procesul de creație implică patru pași principali:
Pasul 1: Activarea înregistrării numărului de cont Advanced Integrated Visibility
Acest pas este gestionat de un administrator FedEx sau de un reprezentant FedEx, la cererea clienților terți.
- Document MNDA: administratorul FedEx sau reprezentantul FedEx va colecta Acordul reciproc de nedivulgare de informații (MNDA) împreună cu o listă în bloc de numere de cont ale părții primare/expeditorului.
Notă: numerele de cont duplicate asociate altor organizații sunt permise în timpul acestei încărcări.
- Dacă este cazul, va fi activată opțiunea Prețuri personalizate la nivel de organizație.
Notă: această funcționalitate nu este inclusă în Experiența din iulie.
Pasul 2: Creați proiectul
În pagina Selectare produs(e):
- Faceți clic pe Advanced Integrated Visibility – Număr cont și apoi pe Înainte.
- Selectați conturile de facturare, acceptați condițiile de plată și faceți clic pe Înainte.
Trebuie să adăugați cel puțin un cont de facturare.
În pagina Confirmare detalii:
- Examinați informațiile despre proiect.
- Acceptați termenele și condițiile.
- Dacă se aplică prețuri personalizate, documentul aferent va apărea automat.
După crearea cu succes, va apărea un mesaj de confirmare:
„Ați adăugat cu succes produsul la «Proiectul meu».”
Pasul 3: Prezentare generală a proiectului - Procesul de activare a cheii interfeței API
- În pagina Prezentare generală a proiectului , în fila Chei API din secțiunea Interfețe API , starea producției pentru înregistrare va apărea inițial ca „Dezactivată”.
- Un administrator sau reprezentant FedEx va activa produsul la cerere.
- Odată activată, fila Cheie producție va deveni accesibilă, iar starea producției va fi actualizată la „În așteptarea confirmării”.
- După activarea finală de către administratorul sau reprezentantul FedEx, starea producției va fi afișată ca „Activată”.
Pasul 4: Prezentare generală a proiectului – Configurați webhookul
- Navigați la pagina Prezentare generală a proiectului.
- Selectați fila Webhookuri.
- Faceți clic pe butonul + Configurare webhookuri pentru a începe configurarea webhookului. Veți fi redirecționat către fila Webhookuri.
Descrieri ale funcțiilor
| Numele câmpului | Descriere |
|---|---|
| Confirmare de primire | Confirmă că o expediere a fost livrată cu succes. Include: Imaginea confirmării de primire (PPOD): furnizează o fotografie care arată locația exactă a livrării. Semnătură de confirmare de primire (SPOD): furnizează o imagine a semnăturii destinatarului, numele, data, ora și locul livrării. |
| Livrare estimată | Ajută beneficiarii să planifice furnizând: Data de livrare estimată (EDD) Intervalul de timp estimat pentru livrare (EDTW) |
| Evenimente de monitorizare | Permite selectarea uneia sau mai multor categorii de evenimente pentru primirea notificărilor: Expediere În tranzit Livrare Excepții Opțiune de livrare personalizate |
| Filtrare bazată pe evenimente | Filtrează răspunsurile webhookului pentru a include: Expedieri de import Expedieri de export Expedieri terțe |
2. În pagina Introducere detalii, furnizați următoarele informații:
| Numele câmpului | Descriere |
|---|---|
| Numele proiectului Webhook | Un nume unic, care nu este gol, pentru proiectul dvs. webhook. Este completat automat un nume sugerat, dar acesta poate fi modificat. Acest nume nu trebuie repetat în niciun alt webhook. |
| URL destinație | Punctul final HTTPS securizat unde FedEx va trimite datele evenimentelor de monitorizare. Cerințe: Trebuie să fie valid și funcțional Trebuie să respecte o sintaxă standardizată Nu trebuie să includă fedex.com sau subdomeniile acestuia Poate fi reutilizat pentru mai multe webhookuri Pentru mai multe detalii, consultați secțiunea Reguli și bune practici în afaceri. |
| Token de securitate | Un secret partajat folosit pentru a autentifica și valida răspunsurile webhookului prin HMAC. Cerințe: 26 – 100 de caractere Trebuie să includă cel puțin 1 literă mare, 1 literă mică și 1 cifră Poate fi reutilizat pentru mai multe webhookuri |
| Limba datelor transmise (Țară) | Selectați din lista derulantă limba preferată pentru traducerea datelor de monitorizare. |
| Tip urmărire | Alegeți modul în care trebuie să fie livrate datele de monitorizare: Monitorizare detaliată – Istoric complet al evenimentelor Monitorizare specifică unui eveniment – Doar cel mai recent eveniment |
| Adresă de e-mail | Furnizați o adresă de e-mail validă pentru a primi notificări. |
| Limba (țara) pentru e-mailuri | Selectați limba preferată pentru notificările prin e-mail. Notă: sunt acceptate doar setările regionale din SUA (de exemplu, en-US, es-US). |
Pasul 3: Alegeți conturi de expediere
În pagina Alegere conturi de expediere:
Selectați unul sau mai multe numere de cont FedEx pentru a le asocia cu proiectul dvs. webhook.
Note importante:
Vor fi afișate doar conturile care nu sunt deja asociate cu alte webhookuri.Trebuie să asociați cel puțin un cont pentru a continua.Pot fi adăugate maximum 100 de conturi prin intermediul interfeței de utilizare a webhookului.
Pentru a asocia mai mult de 100 de conturi, utilizați Interfața API pentru webhookuri.
Contactați Asistența clienți FedEx sau Biroul de asistență pentru a solicita acces la Interfața API.
Pasul 4: Confirmați detaliile și creați
În pagina Confirmare detalii:
1. Verificați toate informațiile pe care le-ați introdus pentru proiectul webhook.
2. Bifați caseta pentru a accepta termenele și condițiile.
3. Faceți clic pe Creare pentru a finaliza configurarea webhookului.
În cazul trimiterii cu succes, webhookul va fi creat cu un ID de înregistrare generat de sistem și va fi setat la starea Activ.
Reguli de validare
Cerințe generale:
Numele webhookului trebuie să fie unic.URL-ul de destinație trebuie să urmeze un format sintactic standardizat (HTTPS securizat, fără fedex.com sau subdomeniile sale).Toate câmpurile obligatorii trebuie completate – niciun câmp obligatoriu nu trebuie lăsat gol.Cel puțin un număr de cont de expediere FedEx valid trebuie să fie asociat cu webhookul.
Validare reușită:
Dacă webhookul este creat cu succes, clientul va primi un mesaj de confirmare:
<<Webhook name>> a fost creat cu succes. Aplicarea modificărilor poate dura până la 10 minute.
Validare nereușită/eșuată:
Dacă FedEx primește orice alt răspuns decât HTTP 200 (OK) sau 202 (Acceptat) de la URL-ul de destinație, validarea webhookului va fi considerată eșuată.
