Johdanto
Laajennettu integroitu näkyvyys ‑asiakasnumerotilaus on suunniteltu Laajennettu integroitu näkyvyys ‑tilaajille, jotta he voivat hallita asiakasnumeroon perustuvia Laajennettu integroitu näkyvyys ‑projektejaan ja suorittaa projekteihin liittyviä toimia, kuten muokata tai tarkastella töiden tietoja API-päätepisteiden avulla.
Huomautus:
- Sinulla on oltava järjestelmänvalvojan oikeudet API-projektiisi, jossa tämä API on käytössä.
- Jos haluat lisätietoja Laajennettu integroitu näkyvyys ‑toiminnosta ja sen ominaisuuksista, vieraile Laajennettu integroitu näkyvyys ‑dokumentaatiosivulla.
Laajennettu integroitu näkyvyys ‑asiakasnumerotilauksen edut
Laajennettu integroitu näkyvyys ‑asiakasnumerotilauksella on seuraavat edut:
- Voit helposti päivittää ja hallita Laajennettu integroitu näkyvyys ‑projektiasi API-päätepisteiden avulla.
- Tämän APIn avulla projektiin voi liittää useita asiakasnumeroita yhdellä API-tapahtumalla, eikä asiakasnumeroita tarvitse valita yksitellen.
Miten Laajennettu integroitu näkyvyys -asiakasnumerotilaus toimii
Laajennettu integroitu näkyvyys ‑projekteja hallitaan seuraavilla päätepisteillä:
Päivitä Laajennettu integroitu näkyvyys -projekti
Tällä päätepisteellä voit päivittää mitä tahansa organisaatiosi Laajennettu integroitu näkyvyys ‑projektin tietoja.
Pyyntöön syötetään seuraavat tiedot:
- requestType: Määritä päivityspyynnön tyyppi.
- ADD_ACCOUNTS: Tällä vaihtoehdolla voit lisätä uusia asiakasnumeroita olemassa olevaan projektiin, jos organisaation kaikki asiakasnumerot on jo liitetty Laajennettu integroitu näkyvyys ‑projektiin.
- DELETE_ACCOUNTS: Tällä vaihtoehdolla voit poistaa asiakasnumeron projektista.
- UPDATE_ALL: Tällä vaihtoehdolla voit päivittää projektia säännöllisesti.
Huomaa: Tämä on valinnainen elementti. UPDATE_ALL valitaan oletuksena, jos käyttäjä ei ole muuta määrittänyt. - category: Määritä projektin päivitettävän ominaisuuden luokka. Esimerkiksi: RETRY_POLICY, PROOF_OF_DELIVERY jne.
- subCategories: Määritä valitun ominaisuuden luokan yksittäiset ominaisuudet. Esimerkiksi: BASIC_HRS, PPOD, SPOD, SHIP, TRAN jne.
Tämän pyynnön onnistuneena vastauksena saadaan tilaustunnus, päivitetyn projektin aikaleima ja ilmoitus siitä, onko projekti päivitetty kaikkien asiakasnumeroiden osalta.
Nouda projektin tietoja
Tämän päätepisteen avulla voit hakea projektin tiedot tietylle Laajennettu integroitu näkyvyys ‑projektille sivutetussa muodossa.
Pyyntöön on syötettävä seuraavat tiedot:
- authorization: Määritä todennustunnus.
- subscriptionId: Määritä Laajennettu integroitu näkyvyys ‑projektin tilaustunnus tietojen hakemista varten.
Onnistunut vastaus tähän pyyntöön luo määritetyn webhook-projektin tiedot sivutetussa muodossa tai antaa vastauksena hälytyksen tai virheen tiedot, jos jokin epäonnistuu.
Yrityssäännöt
- Laajennettu integroitu näkyvyys ‑projektiin voidaan liittää enintään 30 000 lähetyksen asiakasnumeroa yhdellä pyynnöllä.
Response