A Speciális integrált láthatóság működése
A Speciális integrált láthatóság webhook lehetővé teszi, hogy a FedEx biztonságos, közel valós idejű nyomonkövetési frissítéseket küldjön egy adott URL-címre. Ezek a frissítések egy vagy több FedEx-ügyfélszámhoz kapcsolt küldeményekre vonatkoznak. A funkció használatához létre kell hoznia egy Speciális integrált láthatóság webhookprojektet.
A Speciális integrált láthatóság oldalának elérése
A Speciális integrált láthatóság beállításait kétféleképpen érheti el:
1. lehetőség: a Saját projekteken keresztül
1. Lépjen a Saját projektek menüpontra a bal oldali navigációs panelen.
2. Kattintson a Webhookok fülre.
3. Válassza a +WEBHOOKPROJEKT LÉTREHOZÁSA lehetőséget.
2. lehetőség: az API-katalóguson keresztül
1. Nyissa meg az API-katalógust a bal oldali navigációs panelen.
2. Speciális integrált láthatóság keresése.
3. Használja a WEBHOOK szűrőt a megfelelő kártya megtalálásához.
4. A kártyán:
- Kattintson az Áttekintés lehetőségre, majd a Dokumentáció lehetőségre, és válassza a +WEBHOOKPROJEKT LÉTREHOZÁSA lehetőséget.
- Vagy lépjen a DOKUMENTUMOK menüre és kattintson a +WEBHOOKPROJEKT LÉTREHOZÁSA lehetőségre.
1. lépés: Vállalattípus kiválasztása
Kattintson a +PROJEKT LÉTREHOZÁSA gombra , és válassza ki a vállalat típusát a legördülő menüből:
1. A FedExszel fuvaroztat, és a FedEx-webhookot integrálnia kell a rendszerébe.
2. FedEx-adatokat használó szoftvermegoldást értékesít vagy nyújt, és nem tanúsítvánnyal rendelkező FedEx Compatible szolgáltató.
3. FedEx Compatible tanúsítvánnyal rendelkező szolgáltató.
Ezután válassza előfizetési típusként a Speciális integrált láthatóság fuvarlevélszám alapú előfizetését.
Speciális integrált láthatóság fuvarlevélszám alapú előfizetése létrehozása
Létrehozhat egy Speciális integrált láthatóság fuvarlevélszám alapú előfizetést, hogy biztonságos, közel valós idejű nyomonkövetési frissítéseket kapjon egy vagy több FedEx-fuvarlevélszámra vonatkozóan. Ezek a frissítések a megadott cél URL-címre lesznek elküldve.
Előfizetés létrehozásának lépései
A folyamat négy fő lépésből áll:
1. Projekt konfigurálása
2. A projekt részleteinek megadása
3. A részletek megerősítése és a feltételek elfogadása
4. Fuvarlevélszámok hozzáadása
Lépésenkénti útmutató
1. A Webhook konfigurálása lapon:
Ellenőrizze a számlázási ügyfélszámot
Megjelenik szervezete alapértelmezett számlázási ügyfélszáma.
A módosításhoz:
- Kattintson a SZÁMLÁZÁSI ÜGYFÉLSZÁM HOZZÁADÁSA A SZERVEZETHEZ lehetőségre (ha csak egy ügyfélszáma van), vagy
- Kattintson a MÁSIK SZÁMLÁZÁSI ÜGYFÉLSZÁM KIVÁLASZTÁSA lehetőségre (ha több ügyfélszáma van).
Megjegyzés: Az árképzés részleteiért látogasson el a Speciális integrált láthatóság áttekintése oldalra.
2. Funkciók kiválasztása
- Válassza ki a szükséges funkciókat.
- A folytatáshoz kattintson a Tovább gombra.
Tipp: Ha többet szeretne megtudni az egyes funkciókról, kattintson a mellettük lévő súgó ikonra (?).
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. A következőket tartalmazza:
|
| Kézbesítés becsült ideje | Segíti a címzetteket a tervezésben a következőkkel:
|
| 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 megadása oldalon adja meg a következő információkat:
| 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ő marad. 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 elkü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 | Adjon meg érvényes e-mail-címet az értesítések fogadásához. |
| 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). |
3. A Részletek megerősítése oldalon:
- Tekintse át a webhookprojekt részleteit.
- Ellenőrizze és fogadja el a Használati feltételeket.
- Kattintson a Létrehozás gombra, hogy véglegesítse a webhookprojekt beállítását.
4. Miután a kérelmét sikeresen beküldte:
- A FedEx új Webhookprojektet fog létrehozni.
- Meg fogja kapni az élesítési kulcsokat az Advanced Integrated Visibility Tracking Number Subscription API-hoz.
- Ezt az API-t arra használhatja, hogy fuvarlevélszámokat társítson a projektjéhez.
További információkért tekintse meg az Advanced Integrated Visibility Tracking Number Subscription API dokumentációs oldalát.
Fuvarlevélszám hozzáadása egy webhookhoz
Ha fuvarlevélszámot szeretne hozzáadni a webhook-előfizetéshez az Advanced Integrated Visibility Tracking Number Subscription API használatával, kövesse az alábbi lépéseket:
Lépésenkénti folyamat
1. Előfizetési projekt létrehozása
· Használja az előző szakasz lépéseit, vagy tekintse meg az Első lépések útmutatóját.
2. OAuth-token létrehozása
- API-hívások kezdeményezéséhez OAuth-tokenre van szükség.
- A token létrehozásához használja az Authorization API-t.
- A részletes lépéseket tekintse meg az API-katalógusban található Authorization API dokumentációjában.
3. Hozzáférés az API dokumentációjához
- 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 le 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ása | Fuvarlevélszámokat adhat hozzá webhook-elő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 mutat egy adott feladatazonosítóról, például hogy hány fuvarlevélszámot sikerült hozzáadni, vagy hány áll feldolgozás alatt. |
| Fuvarlevélszám – Feladat állapota | Visszaküldi az összes jelenleg feldolgozott feladat összefoglalójá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 hozzá a webhookjához.
Ellenőrzési szabályok:
- A webhook nevének egyedinek kell lennie.
- A cél URL-címnek szabványos szintaktikai formátumban kell lennie.
- Az összes kötelező mezőt ki kell tölteni.
- Legalább egy érvényes FedEx fuvarozási ügyfélszámot kell társítani.
Validálá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 a 200-as (OK) vagy 202-es (Elfogadva) választól eltérő választ kap, a rendszer sikertelennek tekinti a webhook cél URL-jének érvényesítését. |
