Az Advanced Integrated Visibility Tracking Number Subscription API lehetővé teszi a Speciális integrált láthatóság előfizetői számára, hogy a fuvarlevélszámokat egy webhook-projekthez társítsák API-végpontok segítségével. A fuvarlevélszám-társítási képesség két feldolgozási módot támogat:

• A Fuvarlevélszám-társítás – szinkron visszaküldi a feldolgozási eredményeket ugyanabban a HTTP-válaszban. Ez az opció olyan alkalmazásokhoz a legmegfelelőbb, amelyek azonnali megerősítést igényelnek kevesebb fuvarlevélszám hozzárendelésekor. 
• A Fuvarlevélszám-társítás – aszinkron elküldi a háttérfeldolgozásra vonatkozó kérelmet, és visszaküld egy feladatazonosítót, amely később felhasználható a feldolgozási állapot és az eredmények lekéréséhez. Ez az opció a legalkalmasabb nagyobb mennyiségű fuvarlevélszám feldolgozására. 

Válassza ki azt a feldolgozási módszert, amely a legjobban megfelel az alkalmazás teljesítmény- és munkaterhelési követelményeinek.

Megjegyzés:

• Rendszergazdai vagy közreműködői hozzáféréssel kell rendelkeznie a Speciális integrált láthatóság projekthez
• A Speciális integrált láthatósággal és annak funkcióival kapcsolatos további információkért látogasson el a Speciális integrált láthatóság dokumentációs oldalára.

Az Advanced Integrated Visibility Tracking Number Subscription API a következő előnyöket kínálja:

• Az API-végpontok segítségével könnyedén társíthat, frissíthet és kezelhet fuvarlevélszámokat a Speciális integrált láthatóság webhook-projekthez.
• Több fuvarlevélszámot társíthat egyetlen API-kérelemhez ahelyett, hogy az egyes fuvarlevélszámokat külön-külön dolgozná fel.
• Válassza a szinkron feldolgozást az azonnali eredményekhez, vagy az aszinkron feldolgozást a nagyobb kötegelt műveletekhez.

A következő végpontok segítségével kezelheti a Speciális integrált láthatóság projektet:

• A Fuvarlevélszám-társítás – szinkron: lehetővé teszi a fuvarlevélszámok webhookhoz történő társítását, és a végső feldolgozási állapot fogadását ugyanabban a HTTP-válaszban.
• A Fuvarlevélszám-társítás – aszinkron: lehetővé teszi, hogy fuvarlevélszámokat társítson egy webhookhoz, és később a visszaküldött jobId alapján ellenőrizze az aszinkron feladat állapotát, vagy letöltse a részleteket a kapcsolódó végpontok használatával:    
  • Fuvarlevélszám – Feladat állapota
  • Fuvarlevélszám – Feladat részletei

Ezek az API-k elérhetők a Speciális integrált láthatóság projekt áttekintéséből.

Ez az API csak a projekt áttekintésén keresztül érhető el, ahogy a fenti képernyőképen látható.

Az alábbi táblázat összefoglalja a szinkron és aszinkron fuvarlevélszám-társítási végpontok közötti különbségeket.
 

Használja a szinkron végpontot, ha azonnali megerősítésre van szüksége a kisebb kötegek fuvarlevélszámai esetén. Használja az aszinkron végpontot nagyobb, azonnali választ nem igénylő kötegek feldolgozása esetén.

Ezzel a végponttal egy vagy több fuvarlevélszámot társíthat egy Speciális integrált láthatóság webhook-projekthez, és a feldolgozás eredményeit ugyanazon a HTTP-válaszon belül kaphatja meg.

Ez a végpont olyan alkalmazásokhoz készült, amelyek azonnali visszaigazolást igényelnek, és legfeljebb 150 fuvarlevélszámot tartalmazó kérelmeket támogat.

Szükséges bemenet: 

• subscriptionID
• trackingNumber

Előnyök

A szinkron végpont a következő előnyöket biztosítja:

• Azonnali feldolgozási eredmények
• Részletes információk a sikerességről vagy a sikertelenségről egyetlen válaszban
• Kérelmenként akár 150 fuvarlevélszám támogatása
• Kérjük, ellenőrizze a hitelesítést és az üzleti szabályok betartását a feldolgozás előtt
• Géppel olvasható hibakódok és leíró hibaüzenetek
• Tranzakcióazonosítók a kérelmek nyomon követéséhez és a hibaelhárításhoz

A Fuvarlevélszám-társítás – szinkron végpont több hitelesítési szabályt kényszerít, többek között a következőket:

• Érvényes és aktív subscriptionId kötelező
• Csak egy subscriptionId engedélyezett kérelmenként
• trackingNumber megadása kötelező
• Annak biztosítása, hogy a fuvarlevélszámok megfeleljenek a FedEx formátumra vonatkozó követelményeknek, beleértve a 6–22 számjegyű maximális fuvarlevélszám-korlátot is

A hibaválaszok konzisztens struktúrát követnek, az errors[] tartalmazza a kódot és az üzenetet a könnyű feldolgozás érdekében.

"errors": [

{

"code": "ERROR.CODE",

"message": "Leíró hibaüzenet"

}

A Fuvarlevélszám-társítás – szinkron végpont részleges sikereket tesz lehetővé. Ha néhány fuvarlevélszám sikertelen, a Synchronous API továbbra is 200 OK választ küld vissza, és a következőt jeleníti meg:

• failedTrackingNumbers
• Egy leíró üzenet

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "Az alábbi fuvarlevélszámok feltöltése hitelesítési vagy rendszerhiba miatt sikertelen"

      }

    }

További részletekért és szabályokért kérjük, tekintse meg az üzleti szabályok szakaszait.

Ezzel a végponttal egy vagy több előfizetett fuvarlevélszámot küldhet be háttérfeldolgozásra.

A kérelem egy feladatazonosítót küld vissza, amelyet a Fuvarlevélszám – feladat állapota végponttal együtt használhat a feldolgozás figyeléséhez, a Fuvarlevélszám – feladat részletei végponttal pedig a feldolgozási eredményeket töltheti le a feladat befejezése után.

Szükséges bemenet:

• Tevékenység
• Fuvarlevélszám – részletek

Egyetlen kérelemhez legfeljebb 1000 fuvarlevélszámot társíthat.

Előnyök

Az aszinkron végpont a következő előnyöket biztosítja:

• Akár 1000 fuvarlevélszámot tartalmazó, nagy kötegelt beküldést is támogat
• Lehetővé teszi a hosszú ideig futó kérelmek feldolgozását a háttérben
• Lehetővé teszi a feladatok állapotának figyelését és a letölthető feldolgozási jelentéseket
• Kiküszöböli a kérelmek időtúllépésével kapcsolatos aggályokat nagy munkaterhelések esetén

Ezzel a végponttal egy aszinkron feladat (egy vagy több egymást követő kérelem a sorban) vagy az összes benyújtott feladat állapotát kérheti le.

A kéréshez szükséges bemeneti adatok a következők:

• jobID – Adja meg a feladatazonosítót, amelynek állapotát le kívánja kérdezni.

Megjegyzés: A feladatazonosító opcionális paraméter ezen végpont esetén. Ha nem adja meg a feladatazonosítót, akkor az összes benyújtott feladat állapotát kapja meg.

A sikeres válasz erre a kérésre visszaküldi a feladatazonosítót, a feladat aktuális állapotát, valamint a feladat létrehozásának és befejezésének időbélyegét. A válasz a feladatok aktuális állapotát mutatja. Ezenkívül a válasz sikerüzeneteket, hibákat vagy figyelmeztetéseket is tartalmaz, hogy a felhasználók megtekinthessék és adott esetben elháríthassák a hibákat.

• Ha a feladat státusza TELJESÍTETT, az azt jelenti, hogy az összes fuvarlevélszámot hitelesítették és sikeresen feldolgozták.
  • A TELJESÍTETT státusz azt jelenti, hogy a fuvarlevélszámokat hitelesítették és sikeresen feldolgozták. Ez nem jelenti azt, hogy az összes fuvarlevélszámot sikeresen hozzáadták a Speciális integrált láthatósági projekthez.
  • Több fuvarlevélszámmal rendelkező feladatok esetén az állapot BEFEJEZETTNEK tekinthető, még akkor is, ha egyes számok nem társíthatók a projekthez, mások pedig sikeresek. Az eredeti társítási kérelemben szereplő egyes fuvarlevélszámok állapotának ellenőrzéséhez töltse le a kötegelt jelentést.

Megjegyzés: Ha a feladat állapota MEGHIÚSULT, az azt jelenti, hogy különböző okok/nehezített hibák miatt a kérelmet nem lehetett feldolgozni, és a felhasználónak újra kell próbálkoznia.

Az alábbi táblázat a feladatok állapotait és azok leírását mutatja:

Ezzel a végponttal tölthet le JSON-jelentést egy BEFEJEZETT állapotú aszinkron feladatról.

A kérelemhez kapcsolódó szükséges bemeneti adatok a következők:

• jobID – Adja meg a feladatazonosítót, amelynek állapotát le kívánja kérdezni. Ehhez a végponthoz kötelező megadni egy feladatazonosítót.

Megjegyzés:

• Egyszerre csak egy aszinkron feladatjelentést tölthet le.
• Ha a feladat nem BEFEJEZETT, és megpróbálja letölteni a jelentést, akkor egy hibaüzenet jelenik meg.

A sikeres válasz erre a kérelemre JSON-formátumban megadja a feladatról készült jelentést.

Általános üzleti szabályok

• A Speciális integrált láthatóság projekthez társítható fuvarlevélszámok teljes száma nincs korlátozva.
• A Speciális integrált láthatóság projektekhez társított fuvarlevélszámok 40 nappal a webhookhoz való sikeres társításuk után leválasztásra kerülnek.
• A biztonságos nyomonkövetési adatok, például a címzett címe, a címzett aláírása és az érzékeny kézbesítési információk nem érhetők el a Tracking Number Subscription API-n keresztül.

A szinkron végpont üzleti szabályai

• Kérelmenként legfeljebb 150 fuvarlevélszám.
• Minden fuvarlevélszámnak ugyanazt a subscriptionId azonosítót kell használnia.
• A megadott Speciális integrált láthatóság webhook előfizetésnek érvényesnek és aktívnak kell lennie.
• A kérelmekre 30 másodperces időtúllépés vonatkozik.

Az aszinkron végpont üzleti szabályai

• Kérelmenként legfeljebb 1000 fuvarlevélszám.
• A feladat állapota és részletei aszinkron kérés esetén 90 napig megmaradnak, miután a fuvarlevélszámok sikeresen hozzá lettek rendelve a Speciális integrált láthatóság webhookhoz.