A Speciális integrált láthatóság ügyfé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 ügyfélszám alapú Speciális integrált láthatósági projektjeiket, és olyan projektekkel kapcsolatos műveleteket hajthassanak végre, mint a részletek szerkesztése vagy megtekintése API-végpontok segítségével.

Megjegyzés:

• Rendszergazdai hozzáféréssel kell rendelkeznie ahhoz az API-projekthez, amiben ez az API engedélyezve van.
• 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 ügyfé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 projektjeit.
• Ez az API lehetővé teszi több ügyfélszám hozzáadását a projekthez egyetlen API-tranzakció során, ahelyett, hogy az egyes ügyfélszámokat egyesével választaná ki.

Az alábbi végpontok segítségével kezelheti a Speciális integrált láthatóság projektet:

Speciális integrált láthatósági projekt frissítése

Ezzel a végponttal frissítheti a szervezetéhez tartozó Speciális integrált láthatóság projektek részleteit.

A kéréshez kapcsolódó beviteli adat a következő:

• requestType: Adja meg a frissítési kérés típusát. 
  • ADD_ACCOUNTS: Ezzel a lehetőséggel új ügyfélszámokat adhat hozzá a meglévő projekthez, ha a szervezet már minden ügyfélszám esetében Speciális integrált láthatósági projekthez kapcsolódik.
  • DELETE_ACCOUNTS: Ezzel a lehetőséggel bármelyik ügyfélszámot törölheti a projektből.
  • UPDATE_ALL: Használja ezt a lehetőséget a rendszeres projektfrissítésekhez.
Megjegyzés: Ez egy opcionális elem, és alapértelmezés szerint az UPDATE_ALL érték van kiválasztva, ha a felhasználó nem ad meg mást.
• category: Adja meg a projektben frissíteni kívánt funkció kategóriáját. Például: RETRY_POLICY, PROOF_OF_DELIVERY, stb.
• subCategories: Adja meg a kiválasztott funkciókategória egyedi jellemzőit. Például: BASIC_HRS, PPOD, SPOD, SHIP, TRAN, stb.

A kérésre adott sikeres válasz visszaküldi az előfizetési azonosítót, amely jelzi, ha a projektet frissítették a szervezet valamennyi fiókjában, valamint egy időbélyeget a frissített projekthez.

Projektrészletek lekérése

Ezzel a végponttal egy megadott Speciális integrált láthatósági projekt adatait kérheti le oldalszámozott formátumban.

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

• authorization: Adja meg az engedélyezési tokent.
• subscriptionId: Adja meg a Speciális integrált láthatósági projekt előfizetési azonosítóját a részletek lekérdezéséhez.

A kérésre adott sikeres válasz oldalszámozott formátumban hozza létre a megadott webhookprojekt részleteit, vagy hiba esetén riasztást vagy hibarészleteket küld vissza.

• Egy adott kérelemben legfeljebb 30 000 fuvarozási ügyfélszám társítható egy Speciális integrált láthatósági projekthez.