Miten Laajennettu integroitu näkyvyys toimii?
Laajennettu integroitu näkyvyys ‑webhookin avulla FedEx voi lähettää suojattuja, lähes reaaliaikaisia seurantapäivityksiä tiettyyn URL-osoitteeseen. Nämä päivitykset koskevat yhteen tai useampaan FedEx-asiakasnumeroon yhdistettyjä lähetyksiä. Tämän ominaisuuden käyttö edellyttää Laajennettu integroitu näkyvyys ‑webhook-projektin luontia.
Miten Laajennettu integroitu näkyvyys ‑sivulle siirrytään?
Laajennettu integroitu näkyvyys ‑webhookin määrityksiin voi siirtyä kahdella tavalla:
Vaihtoehto 1: Omien hankkeiden kautta
1. Valitse Omat hankkeet vasemmasta siirtymispalkista.
2. Napsauta Webhookit-välilehteä.
3. Valitse +LUO WEBHOOK-PROJEKTI.
Vaihtoehto 2: API-luettelon kautta
1. Avaa API-luettelo vasemmasta siirtymispalkista.
2. Etsi Laajennettu integroitu näkyvyys.
3. Käytä WEBHOOK-suodatinta oikean kortin löytämiseen.
4. Kortissa:
- Napsauta Yhteenveto-painiketta, sitten Dokumentaatio-painiketta ja valitse +LUO WEBHOOK-PROJEKTI.
- Tai siirry kohtaan ASIAKIRJAT ja valitse +LUO WEBHOOK-PROJEKTI.
Vaihe 1: Valitse yrityksen tyyppi
Napsauta +LUO HANKE ‑kohtaa ja valitse yrityksesi tyyppi avattavasta valikosta:
1. Yritys käyttää FedExin lähetyspalveluita, ja FedExin webhook täytyy integroida sen järjestelmään.
2. Yritys myy tai tarjoaa FedExin tietoja hyödyntävää ohjelmistoratkaisua, eikä se ole sertifioitu FedEx Compatible ‑ratkaisun tarjoaja.
3. Yritys on sertifioitu FedEx Compatible ‑ratkaisun tarjoaja.
Valitse sitten tilaustyypiksi Laajennettu integroitu näkyvyys ‑seurantanumerotilaus.
Luo Laajennettu integroitu näkyvyys ‑seurantanumerotilaus
Määrittämällä Laajennettu integroitu näkyvyys ‑seurantanumerotilauksen saat turvallisia, lähes reaaliaikaisia seurantapäivityksiä yhdestä tai useammasta FedEx-seurantanumerosta. Nämä päivitykset lähetetään määrittämääsi kohde-URL-osoitteeseen.
Tilauksen luontivaiheet
Prosessi sisältää neljä päävaihetta:
1. Määritä projekti
2. Anna hankkeen tiedot
3. Vahvista tiedot ja hyväksy ehdot
4. Lisää seurantanumerot
Vaiheittaiset ohjeet
1. Määritä webhook ‑sivulla:
Tarkista laskutettava asiakasnumero
Organisaatiosi oletusarvoinen laskutettava asiakasnumero näytetään.
Voit muuttaa sitä seuraavasti:
- valitse LISÄÄ LASKUTETTAVA ASIAKASNUMERO ORGANISAATIOOSI (jos sinulla on vain yksi asiakasnumero) tai
- valitse VALITSE TOINEN LASKUTETTAVA ASIAKASNUMERO (jos sinulla on useita asiakasnumeroita).
Huomautus: lisätietoja hinnoittelusta on Laajennettu integroitu näkyvyys ‑yleiskatsaus ‑sivulla.
2. Valitse ominaisuudet
- Valitse tarvittavat ominaisuudet.
- Jatka napsauttamalla Seuraava.
Vinkki: saat lisätietoja ominaisuuksista napsauttamalla niiden vieressä olevaa ohjekuvaketta (?).
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:
|
Syötä seuraavat tiedot Anna tiedot ‑sivulla:
| 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). |
3. Vahvista tiedot ‑sivulla:
- Tarkista webhook-projektisi tiedot.
- Tarkista ja hyväksy palvelun ehdot.
- Viimeistele webhook-projektin määritys napsauttamalla Luo.
4. Kun pyyntösi on lähetetty onnistuneesti:
- FedEx luo uuden webhook-projektin.
- Saat tuotantoavaimet Advanced Integrated Visibility Tracking Number Subscription APIa varten.
- Voit käyttää tätä APIa seurantanumeroiden liittämiseen projektiisi.
Lisätietoja on Advanced Integrated Visibility Tracking Number Subscription APIn dokumentaatio ‑sivulla.
Seurantanumeron lisääminen webhookiin
Voit lisätä seurantanumeron webhook-tilaukseen käyttämällä Advanced Integrated Visibility Tracking Number Subscription APIa seuraavasti:
Vaiheittainen prosessi
1. Luo tilausprojekti
· Noudata edellisen osion vaiheita tai katso ohjeet aloitusoppaasta.
2. Luo OAuth-tunniste
- Tarvitset OAuth-tunnisteen API-kutsujen tekemiseen.
- Luo tunniste Authorization APIn avulla.
- Katso tarkat vaiheet API-luettelossa olevan Authorization APIn dokumentaatiosta.
3. 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