Johdanto
Laajennettu integroitu näkyvyys ‑seurantanumerotilaus on suunniteltu Laajennettu integroitu näkyvyys ‑tilaajille, jotta he voivat hallita seurantanumeroon perustuvia webhook‑projektejaan ja suorittaa projekteihin liittyviä toimia, kuten lisätä uusia seurantanumeroita tai muokata tai tarkastella töiden tietoja API-päätepisteiden avulla.
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, vieraile Laajennettu integroitu näkyvyys ‑dokumentaatiosivulla.
Laajennettu integroitu näkyvyys ‑seurantanumerotilauksen edut
Laajennettu integroitu näkyvyys ‑seurantanumerotilauksella on seuraavat edut:
- Laajennettu integroitu näkyvyys ‑projektin seurantanumerot ovat helposti päivitettävissä ja hallittavissa API-päätepisteiden avulla.
- Tämän APIn avulla voit liittää projektiisi useita seurantanumeroita yhdellä API-tapahtumalla sen sijaan, että liittäisit kunkin seurantanumeron erikseen.
- Voit lähettää peräkkäisiä API-pyyntöjä ja tarkastella näiden pyyntöjen onnistumisen tai epäonnistumisen lokitietoja.
Miten Laajennettu integroitu näkyvyys ‑seurantanumerotilaus toimii
Laajennettu integroitu näkyvyys ‑projekteja hallitaan seuraavilla päätepisteillä:
Tätä APIa voidaan käyttää vain projektiyhteenvedon kautta yllä olevan näyttökuvan mukaisesti.
Seurantanumeron liittäminen
Käytä tätä päätepistettä epäsynkronisen työn käynnistämiseen, jotta voit liittää yhden tai useita seurantanumeroita tiettyyn Laajennettu integroitu näkyvyys ‑projektiin.
Pyyntöön on syötettävä seuraavat tiedot:
- Toimenpide – Määritä toimenpide, joka suoritetaan, kun lähetät pyynnön. Esimerkki: LISÄÄ
- Seurantanumeron tiedot – Määritä seurantanumero
Voit liittää enintään 1 000 seurantanumeroa yhteen pyyntöön. Tämän pyynnön onnistunut vastaus palauttaa jobID-tunnuksen, työn nykyisen tilan sekä työn luonnin ja valmistumisen aikaleimat. Tätä jobId-tunnusta voidaan käyttää myöhemmin epäsynkronoidun työn tilan tarkistamiseen.
Seurantanumeron työn tila
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:
- Työn tunnus – Määritä työn tunnus, jonka tilan haluat noutaa.
Huomaa: 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.
- Jos yrität liittää useita seurantanumeroita mutta vain osa niistä liitetään ja osaa ei, myös silloin työtilaksi päivitetään VALMIS. Jos haluat vahvistaa kunkin liittämispyynnössä olevan seurantanumeron tilan, sinun on ladattava eräraportti.
- 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 tulee yrittää sitä uudelleen.
Huomautus:
Seuraavassa on esitelty eri tilat ja niiden kuvaukset:
| TYÖN TILA | KUVAUS |
|---|---|
LÄHETETTY |
Työ lähetetään järjestelmään kaikkien perusvahvistusten jälkeen ja se käsitellään epäsynkronisesti. |
HYVÄKSYTTY |
Työ on hyväksytty ja se asetetaan jonoon. |
HYVÄKSYMÄTÖN |
Työtä ei hyväksytty sisäisen virheen tai järjestelmän käytettävissä olemattomuuden vuoksi, ja käyttäjän on yritettävä suorittaa se uudelleen. |
JONOSSA |
Työ on asetettu jonoon odottamaan käsittelyä, joka alkaa millä hetkellä hyvänsä. |
KÄYNNISSÄ |
Työ on käynnistetty, ja sen tila on KÄYNNISSÄ. |
VALMIS |
Työ on valmis, ja käyttäjä voi ladata tuonti- tai vientiraportin. |
EPÄONNISTUI |
Työ epäonnistui erinäisistä syistä, ja käyttäjän on yritettävä sitä uudelleen. |
Seurantanumeron työn tiedot
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:
- Työn tunnus – Määritä työn tunnus, jonka tilan haluat noutaa.
Huomautus:
- Työn tunnus on pakollinen tieto tälle päätepisteelle.
- Voit ladata kerrallaan vain yhden epäsynkronisen työn raportin.
- Jos työ ei ole VALMIS ja yrität ladata raportin, näkyviin tulee virheilmoitus.
Pyynnön onnistunut vastaus tuottaa työraportin JSON-muodossa.
Yrityssäännöt
- Laajennettu integroitu näkyvyys ‑projektiin voidaan liittää enintään 1 000 lähetyksen seurantanumeroa yhdellä pyynnöllä.
- Seurantanumeroille ei ole määritetty enimmäismäärää, jonka voi liittää yhteen Laajennettu integroitu näkyvyys ‑projektiin.
- Liitettyjen seurantanumeroiden liitos puretaan 40 päivän kuluttua kyseisen Laajennettu integroitu näkyvyys ‑projektin päättymisestä.
- Mahdollisesti luotu työn tunnuksen tila ja tiedot eivät ole saatavilla kyseiselle Laajennettu integroitu näkyvyys ‑projektille 90 päivän kuluttua.
- Suojatut seurantatiedot, kuten vastaanottajan osoite ja vastaanottajan allekirjoitus eivät ole saatavilla Laajennettu integroitu näkyvyys ‑seurantanumerotilauksen kautta.
Response