Yhteenveto
Laajennettu integroitu näkyvyys ‑webhookin avulla FedEx voi lähettää suojattuja seurantatapahtumatietoja lähes reaaliajassa määritettyyn kohde-URL-osoitteeseen lähetyksistä, jotka liittyvät yhteen tai useampaan FedEx-asiakasnumeroon. Voit luoda webhook-projektin, jotta voit käyttää tätä toimintoa FedEx Developer Portalin kautta.
Navigointipolut
Pääset webhookin luontisivulle jommallakummalla seuraavista tavoista:
- Omat hankkeet: Vasen siirtymispalkki → Webhookit-välilehti → +LUO WEBHOOK-PROJEKTI
- API-luettelo:
- Vasen siirtymispalkki → API-luettelo
- Hae tai suodata Laajennettu integroitu näkyvyys ‑vaihtoehdon mukaan
- Yhteenveto → Valitse Dokumentaatio → Valitse testiympäristön konsolissa +LUO HANKE
- Asiakirjat → Valitse +LUO WEBHOOK
Webhookin luontivaiheet
Vaihe 1: Valitse yrityksen tyyppi
Napsauta +LUO HANKE ‑kohtaa ja valitse yrityksesi tyyppi avattavasta valikosta:
- Yritys käyttää FedExin lähetyspalveluita, ja FedExin webhook täytyy integroida sen järjestelmään.
- Yritys myy tai tarjoaa FedExin tietoja hyödyntävää ohjelmistoratkaisua, eikä se ole sertifioitu FedEx Compatible ‑ratkaisun tarjoaja.
- Yritys on sertifioitu FedEx Compatible Provider.
Huomautus: FedExin Laajennettu integroitu näkyvyys ‑webhook ei tällä hetkellä ole saatavilla tätä vaihtoehtoa varten. Jos haluat käyttää Perustason integroitua näkyvyyttä tai muita FedExin integrointiratkaisuja FedEx Compatible ‑ohjelman jäsenenä, ota yhteyttä Channel Manageriisi. Jos et tiedä, kuka Channel Managerisi on, ota yhteyttä yrityksesi ylläpitäjään.
Valitse sitten tilaustyypiksi Laajennettu integroitu näkyvyys ‑asiakasnumerotilaus.
Laajennettu integroitu näkyvyys ‑asiakasnumerotilauksen luominen
Luontiprosessi sisältää neljä päävaihetta:
Vaihe 1: Laajennettu integroitu näkyvyys ‑asiakasnumerotilauksen käyttöönotto
Tätä vaihetta hallinnoi FedExin ylläpitäjä tai FedExin edustaja kolmannen osapuolen asiakkaiden pyynnöstä.
- MNDA-asiakirja: FedExin ylläpitäjä tai FedExin edustaja kerää vastavuoroisen salassapitosopimuksen (MNDA) sekä ensimmäisen osapuolen / lähettäjän asiakasnumeroiden joukkoluettelon.
Huomautus: muihin organisaatioihin liittyvien asiakasnumeroiden kaksoiskappaleet ovat sallittuja tämän latauksen aikana.
- Mukautettu hinnoittelu otetaan tarvittaessa käyttöön organisaatiotasolla.
Huomautus: tämä toiminto ei sisälly July Experienceen.
Vaihe 2: + Luo projekti
Valitse tuote/tuotteet ‑sivulla:
- Napsauta Laajennettu integroitu näkyvyys – asiakasnumero ja napsauta sitten Seuraava.
- Valitse laskutettavat asiakasnumerot, hyväksy maksuehdot ja napsauta Seuraava.
Vähintään yksi laskutettava asiakasnumero on lisättävä.
Vahvista tiedot ‑sivulla:
- Tarkista projektin tiedot.
- Hyväksy palvelun ehdot.
- Jos mukautettua hinnoittelua sovelletaan, asiaan liittyvä asiakirja tulee näkyviin automaattisesti.
Onnistuneen luomisen jälkeen näyttöön tulee vahvistusviesti:
Tuote lisätty omaan hankkeeseen.
Vaihe 3: Projektin yhteenveto – API-avaimen aktivointiprosessi
- Projektin yhteenveto ‑sivun API-avaimet ‑välilehden API:t-osiossa tilauksen tuotantotilana näkyy aluksi Pois käytöstä.
- FedExin ylläpitäjä tai edustaja ottaa tuotteen käyttöön pyynnöstä.
- Kun se on otettu käyttöön, Tuotantoavain-välilehti on käytettävissä ja tuotannon tilaksi päivitetään Odottaa vahvistusta.
- Kun FedExin ylläpitäjä tai edustaja on suorittanut lopullisen aktivoinnin, tuotannon tilaksi tulee Käytössä.
Vaihe 4: Projektin yhteenveto – webhookin määritys
- Siirry Projektin yhteenveto ‑sivulle.
- Valitse Webhookit-välilehti.
- Aloita webhookin määritys napsauttamalla + Määritä webhookeja ‑painiketta. Sinut ohjataan Webhookit-välilehdelle.
Ominaisuuksien kuvaukset
| Kentän nimi | Kuvaus |
|---|---|
| Toimitustodistus | Vahvistaa, että lähetys on toimitettu onnistuneesti. Sisältää seuraavat: Kuvallinen toimitustodistus (PPOD): valokuva, jossa näkyy tarkka toimituspaikka. Allekirjoitettu toimitustodistus (SPOD): kuva vastaanottajan allekirjoituksesta ja nimestä sekä toimituspäivästä, ‑ajasta ja ‑paikasta. |
| Arvioitu toimitus | Auttaa vastaanottajia tekemään suunnitelmia tarjoamalla seuraavat tiedot: arvioitu toimituspäivä (EDD) arvioitu toimitusaikaväli (EDTW). |
| Seurantatapahtumat | Mahdollistaa yhden tai useamman tapahtumaluokan valinnan ilmoitusten vastaanottamiseen: lähetys matkalla toimitus poikkeukset mukautetut toimitusvaihtoehdot. |
| Tapahtumapohjainen suodatus | Suodattaa webhook-vastaukset niin, että ne sisältävät saapuvat lähetykset lähtevät lähetykset kolmannen osapuolen lähetykset. |
2. 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: Sen on oltava kelvollinen ja toimiva. Sen on noudatettava standardoitua syntaksia. Se ei saa sisältää fedex.comia tai sen aliverkkotunnuksia. Sitä voidaan käyttää uudelleen useissa webhookeissa. Lisätietoja on kohdassa Liiketoimintasäännöt ja parhaat käytännöt. |
| Suojaustunniste | Jaettu salaisuus, jota käytetään webhook-vastausten todentamiseen ja vahvistamiseen HMAC:n kautta. Vaatimukset: Se sisältää 26–100 merkkiä. Se sisältää vähintään yhden ison kirjaimen, yhden pienen kirjaimen ja yhden numeron. Sitä voidaan käyttää uudelleen useissa webhookeissa. |
| Hyötykuorman kieli (maakohtainen) | Valitse avattavasta valikosta seurantatietojen käännöksen ensisijainen kieli. |
| Seurantatapa | Valitse seurantatietojen toimitustapa: Yksityiskohtainen seuranta – koko tapahtumahistoria. Tapahtumakohtainen seuranta – vain viimeisin tapahtuma. |
| 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). |
Vaihe 3: Valitse lähettäjän asiakasnumerot
Valitse lähettäjän asiakasnumerot ‑sivulla:
Valitse yksi tai useampi webhook-projektiisi liitettävä FedEx-asiakasnumero.
Tärkeitä huomautuksia:
Vain sellaiset asiakasnumerot näytetään, joita ei ole vielä liitetty muihin webhookeihin.
Sinun on liitettävä vähintään yksi asiakasnumero, jotta voit jatkaa.
Enintään 100 asiakasnumeroa voidaan lisätä webhookin käyttöliittymän kautta.
Jos haluat liittää yli 100 asiakasnumeroa, käytä Webhooks APIa.
Pyydä APIn käyttöoikeutta FedExin asiakaspalvelusta tai tukipalvelusta.
Vaihe 4: Vahvista tiedot ja luo
Vahvista tiedot ‑sivulla:
1. Tarkista kaikki tiedot, jotka olet antanut webhook-projektia varten.
2. Hyväksy palvelun ehdot valitsemalla ruutu.
3. Viimeistele webhookin määritys napsauttamalla Luo.
Onnistunut lähetys luo webhookin, jolla on järjestelmän luoma tilaustunnus ja joka on Aktiivinen-tilassa.
Vahvistussäännöt
Yleiset vaatimukset:
Webhookin nimen on oltava yksilöllinen.
Kohde-URL-osoitteen on noudatettava standardoitua syntaktista muotoa (suojattu HTTPS, ei fedex.comia tai sen aliverkkotunnuksia).
Kaikki pakolliset kentät on täytettävä. Mitään pakollista kenttää ei saa jättää tyhjäksi.
Webhookiin on liitettävä vähintään yksi kelvollinen FedEx-lähettäjän asiakasnumero.
Onnistunut vahvistus:
Jos webhookin luonti on onnistunut, asiakas saa vahvistusviestin:
<<Webhookin nimi>> on luotu. Muutosten päivittyminen voi kestää kymmenen minuuttia.
Epäonnistunut vahvistus:
Jos FedEx saa kohde-URL-osoitteesta jonkin muun vastauksen kuin HTTP 200 (OK) tai 202 (Hyväksytty), webhookin vahvistus katsotaan epäonnistuneeksi.
