A Speciális integrált láthatóság működése
Speciális integrált láthatóság webhook áttekintése
A Speciális integrált láthatóság webhook lehetővé teszi a FedEx számára, hogy közel valós idejű nyomonkövetési eseményadatokat küldjön biztonságosan egy megadott cél URL-címre a kijelölt FedEx-ügyfélszám(ok)hoz kapcsolódó küldemények esetében.
E funkció használatához egy FedEx-rendszergazdának vagy DI-rendszergazdának létre kell hoznia egy Speciális integrált láthatósági webhookprojektet.
Navigációs beállítások
A Speciális integrált láthatóság webhookok oldalát kétféleképpen érheti el:
1. lehetőség: A Saját projekteken keresztül
- Keresse meg a Saját projektek menüpontot a bal oldali navigációs panelen.
- Kattintson a Webhookok fülre.
2. lehetőség: Az API-katalóguson keresztül
- Lépjen az API-katalógushoz a bal oldali navigációs panelen.
- A keresősáv segítségével keresse meg a Speciális integrált láthatóság lehetőséget, vagy válassza ki a SZŰRŐK részből.
- A Webhookkártyán válasszon egyet az alábbiak közül:
- Kattintson a Dokumentumok menüpontra, majd a + Webhookok kezelése lehetőségre
Egy Speciális integrált láthatóság fuvarlevélszám alapú előfizetés projekt megtekintése
1. FedEx személyes hozzáférés és beállítás
- A FedEx-rendszergazda vagy egy FedEx-képviselő fogja kezdeményezni a beállítási folyamatot.
- A szervezeti profilt egy kijelölt rendszergazda hozza létre a CSP-ügyfelek nevében.
- Az ügyfél nevében a rendszergazda hozzáad egy jogosult, egyesült államokbeli számlázási ügyfélszámot szervezeti szinten.
- A beállítást végző rendszergazdának rendelkeznie kell a szervezeti szintű konfigurációk kezeléséhez szükséges jogosultságokkal.
2. Munkafolyamat megtekintése a fuvarlevélszám alapú előfizetéshez
2.1 Az előfizetés megtekintése
- Miután a FedEx-rendszergazda vagy egy képviselője létrehoz egy projektet, a felhasználók megtekinthetik a hozzá tartozó Speciális integrált láthatóság – Fuvarlevélszám alapú előfizetési projektet az irányítópultjukon.
2. Funkciók megtekintése
- A felhasználók felfedezhetik az előfizetéses projekthez kapcsolódó elérhető funkciókat a jobb megértés és felhasználás érdekében.
Funkciók leírása
| Mezőnév | Leírás |
|---|---|
| Kézbesítési igazolás | Megerősíti, hogy a küldeményt sikeresen kézbesítették. Tartalmazza:
|
| Kézbesítés becsült ideje | Segíti a címzetteket a tervezésben azáltal, hogy:
|
| Nyomonkövetési események | Lehetővé teszi egy vagy több eseménykategória kiválasztását az értesítések fogadásához:
|
A Részletek oldalon a következő információk jelennek meg:
| Mezőnév | Leírás |
|---|---|
| Webhookprojekt neve | Egy egyedi, nem üres név az Ön webhookprojektjéhez. A javasolt név automatikusan kitöltésre kerül, de szerkeszthető. Ezt a nevet nem szabad megismételni semmilyen más webhookban. |
| Cél-URL-cím | A biztonságos HTTPS-végpont, ahová a FedEx küldi a nyomonkövetési eseményadatokat. Követelmények:
|
| Biztonsági token | Egy megosztott titkos kód, amely a webhookválaszok HMAC-en keresztüli hitelesítésére és érvényesítésére szolgál. Követelmények:
|
| Adattartalom nyelve (ország) | Válassza ki a legördülő listából, melyik nyelvre szeretné lefordítani a nyomonkövetési adatokat. |
| Nyomonkövetési típus | Válassza ki, hogyan szeretné kézbesíteni a nyomonkövetési adatokat:
|
| E-mail-cím | Értesítések fogadásához adjon meg érvényes e-mail-címet. |
| Az e-mail nyelve (ország) | Válassza ki az e-mailes értesítések kívánt nyelvét. Megjegyzés: Kizárólag az egyesült államokbeli területi értékek támogatottak (pl. en-US, es-US). |
A folyamat lépésenként
4. Előfizetési projekt létrehozása
- Kövesse az előző szakasz lépéseit, vagy tekintse meg az Első lépések útmutatóját.
5. OAuth-token létrehozása
- Az API-hívások kezdeményezéséhez OAuth-tokenre van szüksége.
- A token létrehozásához használja az Authorization API-t.
- A részletes lépéseket lásd az API-katalógusban található Authorization API dokumentációjában.
6. Az API dokumentációjának elérése
- A bal oldali navigációs menüben kattintson a Projekt részletei lehetőségre.
- Az Élesítési kulcsok fül alatt görgessen lefelé az Advanced Integrated Visibility Tracking Number Subscription API dokumentációjához.
API-végpontok áttekintése
| Végpont | Cél |
|---|---|
| Fuvarlevélszám – Társítás | Fuvarlevélszámokat adhat hozzá egy webhookelőfizetéshez, vagy távolíthat el. Ez egy aszinkron feladat. A válaszban egy feladatazonosító kerül visszaküldésre. |
| Fuvarlevélszám – Feladat részletei | Részleteket ad egy adott feladatazonosítóról, például hogy hány fuvarlevélszámot sikerült hozzáadni, vagy hány feldolgozás alatt áll. |
| Fuvarlevélszám – Feladat állapota | Visszaküldi az összes jelenleg feldolgozás alatt álló feladat összefoglalását. |
Használja a 2. lépésben található OAuth-tokent a Fuvarlevélszám-társítási végponttal, hogy fuvarlevélszámokat adjon a webhookhoz.
Ellenőrzési szabályok
- A webhookneveknek egyedinek kell lenniük.
- A cél URL-nek szabványos szintaktikai formátumot kell követnie.
- Minden kötelező mezőt ki kell tölteni.
- Legalább egy érvényes FedEx fuvarozási ügyfélszámot társítani kell.
Ellenőrzés eredményei
| Státusz | Részletek |
|---|---|
| Sikeres | Megjelenik egy megerősítő üzenet: „<> sikeresen létrehozva. A módosítások életbe lépése akár 10 percet is igénybe vehet.” |
| Sikertelen | Ha a FedEx nem 200-as (OK) vagy 202-es (Elfogadva) választ kap, a webhook cél URL-címének érvényesítése sikertelennek minősül. |
