Bevezetés
A Speciális integrált láthatóság fuvarlevélszám alapú előfizetése a Speciális integrált láthatóság előfizetői számára készült, hogy kezelhessék fuvarlevélszám alapú webhookprojektjeiket, és olyan projektekkel kapcsolatos műveleteket hajthassanak végre, mint az új fuvarlevélszámok hozzáadása, a feladat részleteinek szerkesztése vagy megtekintése API-végpontok segítségével.
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.
A Speciális integrált láthatóság fuvarlevélszám alapú előfizetésének előnyei
A Speciális integrált láthatóság fuvarlevélszám alapú előfizetésének előnyei a következők:
- Az API-végpontok segítségével könnyedén frissítheti és kezelheti a Speciális integrált láthatóság projekt fuvarlevélszámait.
- Ez az API lehetővé teszi, hogy több fuvarlevélszámot társítson a projektjéhez egyetlen API-tranzakcióban, ahelyett, hogy minden egyes fuvarlevélszámot egyesével társítana.
- Egymás után küldhet API-kérelmeket, és megtekintheti a kérések sikerének/hiányosságának naplóadatait.
Hogyan működik a Speciális integrált láthatóság fuvarlevélszám alapú előfizetése?
Az alábbi végpontok segítségével kezelheti a Speciális integrált láthatóság projektet:
Ez az API csak a projekt áttekintésén keresztül érhető el, ahogy a fenti képernyőképen látható.
Fuvarlevélszám – Társítás
Ezzel a végponttal aszinkron feladatot indíthat egy vagy több fuvarlevélszám hozzárendeléséhez egy adott Speciális integrált láthatósági projekthez.
A kéréshez szükséges bemeneti adatok a következők:
- Művelet – Adja meg a kérelem benyújtásakor végrehajtandó műveletet. Példa: HOZZÁAD
- Fuvarlevélszám részletei – Adja meg a fuvarlevélszámot
Egyetlen kérelemhez legfeljebb 1000 fuvarlevélszámot társíthat. 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. Ez a feladatazonosító később felhasználható az aszinkron feladat állapotának ellenőrzésére.
Fuvarlevélszám – Feladat állapota
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:
- Feladatazonosító – 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.
- Ha több fuvarlevélszámot próbál társítani, és csak néhányat társít, a többit pedig nem sikerül, a feladat státusza még akkor is TELJESÍTETT lesz. A társítási kérelemben szereplő egyes fuvarlevélszámok állapotának megerősítéséhez a kötegjelentést le kell tölteni.
- 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 meg kell próbálnia.
Megjegyzés:
Az alábbiakban az állapotok és a hozzájuk tartozó leírások következnek:
| FELADAT ÁLLAPOTA | LEÍRÁS |
|---|---|
BEKÜLDVE |
A feladat az összes alapvető hitelesítés után kerül benyújtásra a rendszerbe, a feldolgozás aszinkron módon történik. |
ELFOGADVA |
A feladatot elfogadták, és sorba kerül. |
NINCS ELFOGADVA |
A feladat belső hiba vagy a rendszer elérhetetlensége miatt nem fogadható el, a felhasználónak újra meg kell próbálnia. |
SORBAN ÁLL |
A feladat feldolgozásra váró sorban áll, és a feldolgozás bármikor megkezdődhet. |
FOLYAMATBAN |
A feladat elindult, és folyamatban van. |
BEFEJEZVE |
A feladat befejeződött, és a felhasználó letöltheti az importálási jelentést vagy az exportálási fájlt. |
MEGHIÚSULT |
A feladat különböző okok miatt sikertelen volt, és a felhasználónak újra kell próbálkoznia. |
Fuvarlevélszám – Feladat részletei
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:
- Feladatazonosító – Adja meg a feladatazonosítót, amelynek állapotát le kívánja kérdezni.
Megjegyzés:
- A feladat azonosítója kötelező bemeneti adat ehhez a végponthoz.
- Egyszerre csak egy aszinkron feladat jelentését töltheti 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.
Üzleti szabályok
- Egy-egy Speciális integrált láthatósági projekt esetén egy kérelemben legfeljebb 1000 fuvarozási fuvarlevélszám társítható.
- Az egy adott Speciális integrált láthatóság projekthez társítható maximális fuvarlevélszámok nincsenek korlátozva.
- A kapcsolódó fuvarlevélszám(ok) 40 nap elteltével leválasztásra kerülnek egy adott Speciális integrált láthatósági projektről.
- A létrehozott feladatazonosító státusza és részletei 90 nap elteltével nem lesznek elérhetők egy adott Speciális integrált láthatósági projekt esetében.
- A biztonságos nyomonkövetési információk, mint például a címzett címe, a címzett aláírása nem lesznek elérhetők a Speciális integrált láthatóság fuvarlevélszám alapú előfizetésein keresztül.
Response