Miten Laajennettu integroitu näkyvyys toimii?
Laajennettu integroitu näkyvyys ‑webhookin yleiskatsaus
Laajennettu integroitu näkyvyys ‑webhookin avulla FedEx voi suojatusti lähettää lähes reaaliaikaisia seurantatapahtumatietoja määritettyyn kohde-URL-osoitteeseen lähetyksistä, jotka on yhdistetty määritettyihin FedEx-asiakasnumeroihin.
Tämän toiminnon käyttöä varten FedExin ylläpitäjän tai DI:n ylläpitäjän on luotava Laajennettu integroitu näkyvyys ‑webhook-projekti.
Navigointivaihtoehdot
Laajennettu integroitu näkyvyys ‑webhookit ‑sivulle voi siirtyä kahdella tavalla:
Vaihtoehto 1: Omien hankkeiden kautta
- Siirry omiin hankkeisiin vasemmasta siirtymispalkista.
- Napsauta Webhookit-välilehteä.
Vaihtoehto 2: API-luettelon kautta
- Siirry API-luetteloon vasemmasta siirtymispalkista.
- Etsi Laajennettu integroitu näkyvyys käyttämällä hakupalkkia tai valitse se SUODATTIMET-kohdasta.
- Valitse Webhook-kortissa jokin seuraavista:
- Valitse Asiakirjat → valitse sitten + Hallitse webhookeja
Laajennettu integroitu näkyvyys ‑seurantanumerotilausprojektin tarkastelu
1. FedExin henkilöstön pääsy ja määritys
- FedExin ylläpitäjä tai FedExin edustaja aloittaa määritysprosessin.
- Nimetty ylläpitäjä luo organisaation profiilin CSP-asiakkaiden puolesta.
- Ylläpitäjä lisää kelvollisen Yhdysvalloissa olevan laskutettavan asiakasnumeron organisaatiotasolla asiakkaan puolesta.
- Tämän määrityksen suorittavalla ylläpitäjällä on oltava asianmukaiset oikeudet organisaatiotason määritysten hallintaa varten.
2. Seurantanumerotilauksen tarkastelun työnkulku
2.1 Tilauksen tarkastelu
- Kun FedExin ylläpitäjä tai edustaja on luonut projektin, käyttäjät voivat tarkastella siihen liittyvää Laajennettu integroitu näkyvyys ‑seurantanumerotilausprojektia koontinäytössään.
2. Ominaisuuksien tarkastelu
- Käyttäjät voivat tutustua tilausprojektiin saatavilla oleviin ominaisuuksiin, jotta he ymmärtäisivät ja voisivat hyödyntää niitä paremmin.
Ominaisuuksien kuvaukset
| Kentän nimi | Kuvaus |
|---|---|
| Toimitustodistus | Vahvistaa, että lähetys on toimitettu onnistuneesti. Sisältää seuraavat:
|
| Arvioitu toimitus | Auttaa vastaanottajia tekemään suunnitelmia tarjoamalla seuraavat tiedot:
|
| Seurantatapahtumat | Mahdollistaa yhden tai useamman tapahtumaluokan valinnan ilmoitusten vastaanottamiseen:
|
Tiedot-sivulla näytetään seuraavat tiedot:
| Kentän nimi | Kuvaus |
|---|---|
| Webhook-projektin nimi | Webhook-projektisi yksilöllinen, ei-tyhjä nimi. Ehdotettu nimi täytetään automaattisesti, mutta sitä voidaan muokata. Tätä nimeä ei saa toistaa missään muussa webhookissa. |
| Kohde-URL | Suojattu HTTPS-päätepiste, johon FedEx lähettää seurantatapahtumatiedot. Vaatimukset:
|
| Suojaustunniste | Jaettu salaisuus, jota käytetään webhook-vastausten todentamiseen ja vahvistamiseen HMAC:n kautta. Vaatimukset:
|
| Hyötykuorman kieli (maakohtainen) | Valitse avattavasta valikosta seurantatietojen käännöksen ensisijainen kieli. |
| Seurantatapa | Valitse seurantatietojen toimitustapa:
|
| Sähköpostiosoite | Anna kelvollinen sähköpostiosoite ilmoitusten vastaanottamiseen. |
| Sähköpostin kieli (maa) | Valitse ensisijainen kieli sähköposti-ilmoituksia varten. Huomautus: vain Yhdysvaltojen kieliä tuetaan (esim. en-US, es-US). |
Vaiheittainen prosessi
4. Luo tilausprojekti
- Noudata edellisen osion vaiheita tai katso ohjeet aloitusoppaasta.
5. Luo OAuth-tunniste
- Tarvitset OAuth-tunnisteen API-kutsujen tekemiseen.
- Luo tunniste Authorization APIn avulla.
- Katso tarkat vaiheet API-luettelossa olevan Authorization APIn dokumentaatiosta.
6. Siirry API-dokumentaatioon
- Valitse vasemmasta siirtymisvalikosta Projektin tiedot.
- Vieritä Tuoteavaimet-välilehteä, kunnes löydät Advanced Integrated Visibility Tracking Number Subscription APIn dokumentaation.
API-päätepisteiden yleiskatsaus
| Päätepiste | Tarkoitus |
|---|---|
| Seurantanumeron liittäminen | Seurantanumeroiden lisääminen webhook-tilaukseen tai poistaminen siitä. Tämä on epäsynkroninen työ. Vastauksessa palautetaan työn tunnus. |
| Seurantanumerotyön tiedot | Antaa tietyn työn tunnuksen tiedot, kuten kuinka monta seurantanumeroa on lisätty onnistuneesti tai kuinka monta seurantanumeroa on vielä käsittelyssä. |
| Seurantanumerotyön tila | Palauttaa yhteenvedon kaikista tällä hetkellä käsiteltävistä töistä. |
Lisää seurantanumeroita webhookiisi käyttämällä vaiheen 2 OAuth-tunnistetta seurantanumeron liittämisen päätepisteen kanssa.
Vahvistussäännöt
- Webhookin nimen on oltava yksilöllinen.
- Kohde-URL-osoitteen on noudatettava standardoitua syntaktista muotoa.
- Kaikki pakolliset kentät on täytettävä.
- Vähintään yksi kelvollinen FedEx-lähettäjän asiakasnumero on liitettävä.
Validoinnin tulokset
| Tila | Tiedot |
|---|---|
| Onnistunut | Vahvistusviesti tulee näkyviin: ”<> on luotu. Muutosten päivittyminen voi kestää kymmenen minuuttia.” |
| Epäonnistunut | Jos FedEx saa jonkin muun vastauksen kuin 200 (OK) tai 202 (Hyväksytty), webhookin kohde-URL-osoitteen vahvistus katsotaan epäonnistuneeksi. |
Response