Laajennettu integroitu näkyvyys ‑seurantanumerotilauksen API tarjoaa Laajennettu integroitu näkyvyys ‑tilaajille mahdollisuuden liittää seurantanumerot webhook-projektiin API-päätepisteiden avulla. Seurantanumeroiden liittämisominaisuus tukee kahta käsittelytapaa:

• Seurantanumeron liittäminen – synkronoitu palauttaa käsittelytulokset samassa HTTP-vastauksessa. Tämä vaihtoehto sopii parhaiten sovelluksiin, jotka vaativat välittömän vahvistuksen, kun yhdistetään pienempi määrä seurantanumeroita. 
• Seurantanumeron liittäminen – epäsynkronoitu lähettää pyynnön taustakäsittelyyn ja palauttaa työtunnuksen, jota voidaan käyttää käsittelyn tilan ja tulosten hakemiseen myöhemmin. Tämä vaihtoehto sopii parhaiten suurempien seurantanumeroerien käsittelyyn. 

Valitse käsittelymenetelmä, joka parhaiten vastaa sovelluksesi suorituskyky- ja työkuormavaatimuksia.

Huomautus:

• Sinulla on oltava järjestelmänvalvojan tai avustajan käyttöoikeus Laajennettu integroitu näkyvyys ‑projektiisi
• Jos haluat lisätietoja Laajennettu integroitu näkyvyys ‑toiminnosta ja sen ominaisuuksista, käy Laajennettu integroitu näkyvyys ‑dokumentaatiosivulla.

Laajennettu integroitu näkyvyys ‑seurantanumerotilaus-API tarjoaa seuraavat edut:

• Laajennettu integroitu näkyvyys ‑webhook-projektin seurantanumerot ovat helposti liitettävissä, päivitettävissä ja hallittavissa API-päätepisteiden avulla.
• Liitä useita seurantanumeroita yhteen API-pyyntöön sen sijaan, että käsittelisit jokaisen seurantanumeron erikseen.
• Valitse synkronoitu käsittely välittömiä tuloksia varten tai epäsynkronoitu käsittely suurempia erätoimintoja varten.

Laajennettu integroitu näkyvyys ‑projekteja hallitaan seuraavilla päätepisteillä:

• Seurantanumeron liittäminen – synkronoitu: voit liittää seurantanumerot webhookiin ja vastaanottaa lopullisen käsittelytilan samassa HTTP-vastauksessa.
• Seurantanumeron liittäminen – epäsynkronoitu: voit liittää seurantanumerot webhookiin ja käyttää palautettua jobId-arvoa myöhemmin epäsynkronoidun työn tilan tarkistamiseen tai tietojen lataamiseen liittyvien päätepisteiden avulla:    
  • Seurantanumeron työn tila
  • Seurantanumeron työn tiedot

Nämä APIt ovat saatavilla Laajennettu integroitu näkyvyys ‑projektisi yhteenvedossa.

Näitä API-rajapintoja voidaan käyttää vain projektiyhteenvedon kautta yllä olevan näyttökuvan mukaisesti.

Seuraavassa taulukossa on yhteenveto synkronoitujen ja epäsynkronoitujen seurantanumeron liittämisen päätepisteiden eroista.
 

Käytä synkronoitua päätepistettä, kun tarvitset välittömän vahvistuksen pienemmille seurantanumeroerille. Käytä epäsynkronoitua päätepistettä, kun käsittelet suurempia eriä, jotka eivät vaadi välitöntä vastausta.

Tämän päätepisteen avulla voit liittää yhden tai useamman seurantanumeron Laajennettu integroitu näkyvyys ‑webhook-projektiin ja saada käsittelytulokset samassa HTTP-vastauksessa.

Tämä päätepiste on tarkoitettu sovelluksille, jotka edellyttävät välitöntä vahvistusta, ja se tukee pyyntöjä, jotka sisältävät enintään 150 seurantanumeroa.

Vaadittu syöte: 

• subscriptionID
• trackingNumber

Edut

Synkronoitu päätepiste tarjoaa seuraavat edut:

• Välittömät käsittelytulokset
• Yksityiskohtaiset tiedot onnistumisesta ja epäonnistumisesta yhdessä vastauksessa
• Tuki enintään 150 seurantanumerolle pyyntöä kohti
• Pyydä vahvistusta ja liiketoimintasääntöjen toteutusta ennen käsittelyä
• Koneluettavat virhekoodit ja kuvailevat virheilmoitukset
• Tapahtumatunnukset pyyntöjen jäljitystä ja vianmääritystä varten

Seurantanumeron liittäminen – epäsynkronoitu päätepiste valvoo useita vahvistussääntöjä, mukaan lukien:

• Vaaditaan voimassa oleva ja aktiivinen subscriptionId
• Sallitaan vain yksi subscriptionId pyyntöä kohti
• Vaaditaan trackingNumber
• Varmistetaan, että seurantanumerot täyttävät FedExin muotoiluvaatimukset, mukaan lukien seurantanumeroiden enimmäisrajoitus 6–22 numeroa

Virhevastaukset noudattavat yhtenäistä rakennetta, jossa virheissä on koodi ja viesti helppoa jäsentämistä varten.

"errors": [

{

"code": "ERROR.CODE",

"message": "Kuvaileva virheilmoitus"

}

Seurantanumeron liittäminen – synkronoitu päätepiste mahdollistaa osittaiset onnistumiset. Kun jotkin seurantanumerot epäonnistuvat, synkronoitu API palauttaa silti arvon 200 OK ja näyttää seuraavan:

• failedTrackingNumbers
• Kuvaileva viesti

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "Seuraavia seurantanumeroita ei voitu ladata vahvistus- tai järjestelmävirheiden vuoksi"

      }

    }

Katso lisätietoja ja sääntöjä liiketoimintasääntöjä käsittelevistä osioista.

Tällä päätepisteellä voit lähettää yhden tai useamman tilatun seurantanumeron taustakäsittelyä varten.

Pyyntö palauttaa työn tunnuksen, jota voit käyttää seurantanumeron työn tila ‑päätepisteen kanssa käsittelyn seuraamiseen ja seurantanumeron työn tiedot ‑päätepisteen kanssa käsittelyn tulosten lataamiseen työn valmistumisen jälkeen.

Vaadittu syöte:

• Toimenpide
• Seurantanumeron tiedot

Voit liittää enintään 1 000 seurantanumeroa yhteen pyyntöön.

Edut

Epäsynkronoitu päätepiste tarjoaa seuraavat edut:

• Tukee suuria erälähetyksiä, joissa on jopa 1 000 seurantanumeroa
• Sallii pitkään jatkuvien pyyntöjen käsittelyn taustalla
• Mahdollistaa työn tilan seurannan ja ladattavat käsittelyraportit
• Poistaa pyyntöjen aikakatkaisuongelmat suurien työkuormien osalta

Käytä tätä päätepistettä nähdäksesi epäsynkronisen työn tilan (yksi tai useampi peräkkäinen pyyntö jonossa) tai kaikkien lähetettyjen töiden tila.

Pyyntöön on syötettävä seuraavat tiedot:

• jobID – Määritä työn tunnus, jonka tilan haluat noutaa.

Huomautus: Työn tunnus on valinnainen tieto tälle päätepisteelle. Jos et määritä työn tunnusta, näet kaikkien lähetettyjen töiden tilan.

Tämän pyynnön onnistunut vastaus palauttaa jobID-tunnuksen, työn nykyisen tilan sekä työn luonnin ja valmistumisen aikaleimat. Vastaus näyttää töiden nykyisen tilan. Lisäksi vastaus sisältää myös onnistumisviestejä, virheilmoituksia tai varoituksia, joissa käyttäjää kehotetaan tarkastelemaan virheitä ja tekemään niille vianmäärityksen.

• Jos työn tilana näkyy VALMIS, tämä tarkoittaa, että kaikki seurantanumerot on vahvistettu ja käsitelty.
  • VALMIS-tila tarkoittaa, että seurantanumerot on vahvistettu ja käsitelty. Se ei tarkoita sitä, että kaikki seurantanumerot on lisätty Laajennettu integroitu näkyvyys ‑projektiin.
  • Useita seurantanumeroita sisältävien töiden tilan voidaan katsoa olevan VALMIS, vaikka jotkin numerot eivät liittyisi projektiin ja toiset onnistuisivat. Jos haluat vahvistaa kunkin alkuperäisessä liittämispyynnössä olevan seurantanumeron tilan, lataa eräraportti.

Huomautus: Jos työn tilana näkyy EPÄONNISTUI, se tarkoittaa, että erinäisistä syistä / vakavista virheistä johtuen pyyntöä ei voitu käsitellä, ja käyttäjän on yritettävä sitä uudelleen.

Seuraavassa taulukossa näkyvät työtehtävien tilat ja niiden kuvaukset:

Käytä tätä päätepistettä JSON-raportin lataamiseksi epäsynkroniselle työlle, jonka tila on VALMIS.

Seuraavat tähän pyyntöön liittyvät tiedot ovat pakollisia:

• jobID – Määritä työn tunnus, jonka tilan haluat noutaa. Työn tunnus on pakollinen tieto tälle päätepisteelle.

Huomautus:

• Voit ladata vain yhden epäsynkronoidun työraportin kerrallaan.
• Jos työ ei ole VALMIS ja yrität ladata raportin, näkyviin tulee virheilmoitus.

Pyynnön onnistunut vastaus tuottaa työraportin JSON-muodossa.

Yleiset liiketoimintasäännöt

• Laajennettu integroitu näkyvyys ‑projektiin liitettävien seurantanumeroiden kokonaismäärää ei ole rajoitettu.
• Laajennettu integroitu näkyvyys ‑projektiin liittyvät seurantanumerot poistetaan 40 päivän kuluttua siitä, kun ne on yhdistetty webhookiin.
• Suojatut seurantatiedot, kuten vastaanottajan osoite, vastaanottajan allekirjoitus ja arkaluonteiset toimitustiedot, eivät ole saatavilla seurantanumerotilauksen APIn kautta.

Synkronoidun päätepisteen liiketoimintasäännöt

• Enintään 150 seurantanumeroa pyyntöä kohti.
• Kaikkien seurantanumeroiden on käytettävä samaa subscriptionId-tunnusta.
• Määritetyn Laajennettu integroitu näkyvyys ‑webhook-tilauksen on oltava voimassa ja aktiivinen.
• Pyyntöihin kohdistuu 30 sekunnin aikakatkaisu.

Epäsynkronoidun päätepisteen liiketoimintasäännöt

• Enintään 1 000 seurantanumeroa pyyntöä kohti.
• Epäsynkronoidun pyynnön työn tilaa ja tietoja säilytetään 90 päivän ajan sen jälkeen, kun seurantanumerot on yhdistetty Laajennettu integroitu näkyvyys ‑webhookiin.