Streamed Statuses tarjoaa tavan selvittää lähetyksiesi tilamuutokset nopeasti. Sinun ei tarvitse hakea tietoja getStatus-kutsulla; toimitamme datan sinulle suoratoistona push-mekanismin avulla. Voit tilata tapahtumia, ja kun päivitys tapahtuu, lähetämme tilatiedot siihen URL-osoitteeseen, jonka määrität kentässä MyTranssmart valikossa Manage account > Streamed Statuses.
Ensimmäinen vaihe on ottaa yhteyttä tukiosastoomme, jotta voimme aktivoida toiminnallisuuden sinulle. Aktivoimme sen ensin Accept-ympäristössämme, jotta voit konfiguroida ja testata integraation. Kun tämä on onnistunut, aktivoimme sen Production-ympäristössä.
Määritys
Varmista ensin, että sinulla on autentikoitu endpoint, joka voi vastaanottaa statuspäivityksiä.
Seuraavaksi ota määritys käyttöön ja täytä konfiguraatio asetussivulla.
- URL = sinun endpoint-osoitteesi
- Authentication = valitse None, Header tai Basic riippuen omasta konfiguraatiovalinnastasi.
- Status push method = valitse Package level (oletus) tai Shipment level. Katso selitys alla
Tärkeä huomio: (lue myös alla oleva joulukuun 2024 päivitys)
Tee mapping siten, että luet tilan arvon kentästä genericStatusCode objektissa shipmentLines etkä shipmentStatus-kentästä shipment header -tasolla. Syy tähän on se, että joidenkin kuljetusliikkeiden osalta emme vastaanota tilapäivitystä shipment header -tasolle, ja algoritmilla muutamme shipment header -tason tilan vasta sen jälkeen, kun olemme tarkistaneet tilan per shipment line.
Esimerkki:
Lähetyksessä on 3 riviä:
Rivi 1: paketti tilalla DONE
Rivi 2: paketti tilalla TRNS
Rivi 3: paketti tilalla TRNS
Shipment header -taso on tilassa TRNS
Vastaanotamme pakettirivin 2 tilapäivityksen, jonka tila muuttuu arvoon DONE. Koska rivillä 3 on yhä paketti tilalla TRNS, algoritmi ei muuta lähetyksen otsikkotietueen tilaa, joten se säilyy tilassa TRNS.
Vastaanotamme pakettirivin 3 tilapäivityksen, jonka tila muuttuu arvoon DONE. Koska yhtään pakettia tilalla TRNS ei enää ole, algoritmi muuttaa lähetyksen otsikkotietueen tilan arvoon DONE. Siinä vaiheessa, kun saimme tilapäivityksen, olimme kuitenkin jo lähettäneet tilaviestinne endpointiinne. Tällä hetkellä otsikon kentän shipmentStatus arvo oli yhä TRNS, kun taas shipmentLine-rivin genericStatusCode oli tilassa DONE. Jos tekisitte mapppauksen lähetyksen otsikkotason tilaan, lähetys jäisi järjestelmässänne tilaan TRNS eikä muuttuisi tilaan DONE. Siksi on tärkeää tehdä mapping kentän genericStatusCode tilaarvon perusteella kohteessa shipmentLines.
Päivitys: joulukuussa 2024 lisäsimme asetuksen, jolla voidaan määrittää, laukaistaanko lähettämästämme viestistä pakkausrivien vai lähetyksen otsikon perusteella.
Oletusasetuksena käytetään edelleen pakkausriviä kohden. Jos haluat muuttaa sen lähetyksen otsikkoon perustuvaksi, muuta asetusta. Sinun on tehtävä tämä, jos et pysty yhdistämään kenttään genericStatusCode kentässä shipmentLines.
Uusi asetus on käytettävissä konfigurointisivulla kohdassa Manage account > Streamed Statuses
Viestin formaatti
Lähetettävä payload statusilmoituksessa on sama kuin vastaus status-hakupyyntöihin, DevDocs-dokumentaatiomme kappaleessa 5.1: https://devdocs.transsmart.com/#_5_2_status_stream
isIncremental
Parametri isIncremental, jota käytetään Status Retrieval API -endpointteihin, ei muutu järjestelmämme lähettämien viestien myötä. Jos haluat edelleen hakea statuksia omaan järjestelmääsi, tai ehkä toiseen järjestelmään, se on edelleen mahdollista.
Alitilit
Jos sinulla on kokoonpano, jossa on yksi päätili ja yksi tai useampi alitili, sen määrittäminen riippuu endpoint-konfiguraatiosta. Jos sinulla on yksi endpoint, johon haluat vastaanottaa kaikkien tilien statusviestit, riittää, että konfiguroit sen vain päätilille. Asetus periytyy automaattisesti kaikille alitileille.
Jos sinulla on eri endpoint jokaiselle alitilille, voit konfiguroida sen alitilikohtaisesti.