Näin pääset alkuun
FedEx Developer Portal ‑portaalissa on useita ohjelmointirajapintoja (API:t), joilla FedEx integroidaan sovelluksiisi. Nämä ohjeet opastavat sinua organisaation määrittämisessä, projektin luomisessa, integraatiosi testaamisessa, projektin siirtämisessä tuotantoon ja joissakin tapauksissa API:n vahvistamisessa.
Käyttäjätyypit:
FedEx tarjoaa integrointipalveluita kolmentyyppisille käyttäjille: FedEx-lähettäjille, vahvistetuille ohjelmistoratkaisuille, jotka tunnetaan nimellä FedEx Compatible ‑ratkaisun tarjoaja, ja vahvistetuille FedEx Integrator ‑ratkaisun tarjoajille.
FedEx-lähettäjä:
Yritys, joka käyttää FedExin lähetyspalveluita ja jonka täytyy integroida FedExin API:t omiin sovelluksiinsa.
Ratkaisujen tarjoaja tai palveluntarjoaja:
Yritys, jonka on integroiduttava FedExin API-rajapintoihin sellaisen ratkaisun, sovelluksen tai laajennuksen tuottamiseksi, jota voidaan myydä ja/tai jakaa ulkoiselle organisaatiolle, joka lähettää FedExillä.
- FedEx Compatible Provider: vahvistettu yritys, jolla on sopimus FedEx Compatible -ohjelman kautta.
- FedEx Integrator ‑ratkaisun tarjoaja: vahvistettu yritys, jolla on sopimus FedEx Integrator ‑ohjelman kautta.
Valitse alta vaihtoehto, joka parhaiten kuvaa yritystäsi. Sinulle on tarjolla aloituskokemus käyttäjätyypistäsi riippumatta.
Tee valinta, niin pääset alkuun.
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
Edellytys
FedEx Developer Portaliin kirjautumiseen ja organisaation luomiseen tarvitaan FedEx-käyttäjätunnus.
Jos yritykselläsi ei ole organisaatiota, luo se. Muussa tapauksessa liity johonkin olemassa olevaan organisaatioon.
Luo uusi organisaatio
Napsauta siirtymispalkissa Luo organisaatio tai liity organisaatioon.
Huomautus: organisaation luojana sinut määritetään automaattisesti organisaation ylläpitäjäksi.
Ylläpitäjät voivat
kutsua käyttäjiä liittymään
määrittää käyttäjille rooleja (esim. avustaja tai katsoja) ja hankkeita
hallita asiakasnumeroita.
Lisätietoja näistä rooleista on organisaation hallintaoppaassa.
Valitse yrityksen tyypiksi ”Yritys myy tai tarjoaa FedExin teknologiaa hyödyntävää ohjelmistoratkaisua, ja se on vahvistettu FedEx Integrator Provider”.
Anna yrityksen nimi, verkkosivuston URL-osoite ja yksilöllinen organisaation nimi. Organisaation nimi voi olla sama kuin yrityksesi nimi tai edustaa tiettyä ryhmää (osasto, jaosto, alue, sijainti). Nämä tiedot ovat tarpeen pyyntösi vahvistamiseksi.
Huomautus: valitse organisaatiolle nimi, jonka kaikki muut käyttäjät tunnistavat (esim. yrityksen nimi, osasto, alue, sijainti).
Määritä yrityksesi sijainti ja missä ohjelmistoratkaisuasi myydään tai jaellaan.
Lisää laskutettava asiakasnumero ja todenna asiakasnumero
Huomautus: FedEx Integrator ‑ohjelman lähetys- ja logistiikkapalveluntarjoajana sinun on käytettävä omaa asiakasnumeroasi. Et voi käyttää asiakkaan FedEx-asiakasnumeroa.
Anna FedEx-asiakasnumerosi. Jos sinulla ei ole olemassa olevaa FedEx-asiakasnumeroa, luo se osoitteessa fedex.com tai ota yhteys FedExin asiakaspalveluun.
Anna asiakasnumeron kutsumanimi ja asiakasnumeroon liittyvä laskutusosoite. Valitse Seuraava.
Huomautus: Laskutusosoitteen on vastattava tietueitamme tälle asiakasnumerolle. Tämä on organisaatiosi oletusarvoinen laskutettava asiakasnumero.
Organisaatiosi luonnin viimeistely edellyttää asiakasnumeron todennusta. Valitse todennusvaihtoehto (puhelin käytettävissä integraattorille vain Yhdysvalloissa ja Kanadassa, sähköposti, tekstiviesti) ja valitse Seuraava.
Kun olet saanut todennuskoodin, anna se ja valitse Lähetä.
Hyväksy käyttöehdot
Lue maailmanlaajuinen integraattorisopimus ja ohjelman opas. Vahvista ehtojen hyväksyminen valitsemalla valintaruudut ja valitse sitten Hyväksy.
Vahvistusnäyttö tulee näkyviin. Muokkaa tietoja tarvittaessa napsauttamalla Hallitse organisaatiota.
Kutsu käyttäjiä
Huomautus: vain ylläpitäjät voivat kutsua käyttäjiä.
Valitse vasemmanpuoleisesta siirtymispalkista Hallitse organisaatiota.
Siirry Käyttäjät-välilehdelle ja valitse Lisää käyttäjiä.
Täytä lomake ja määritä uusille käyttäjille asianmukainen rooli: katsoja, avustaja tai ylläpitäjä.
Lisätietoja käyttäjärooleista on organisaation hallintaoppaassa.
Määritä käyttäjät hankkeisiin (soveltuvissa tapauksissa) avattavasta Hankkeet-valikosta.
Anna kunkin käyttäjän sähköpostiosoite ja valitse sitten Kutsu.
Liity olemassa olevaan organisaatioon
Pyydä kutsua: Pyydä organisaatiosi ylläpitäjää lähettämään sinulle kutsu. Sinulla on 24 tuntia aikaa hyväksyä kutsu ennen kuin se vanhenee. Pyydä ylläpitäjää tarvittaessa lähettämään se uudelleen.
Hyväksy kutsu: Kirjaudu sisään olemassa olevalla käyttäjätunnuksellasi ja salasanallasi. Jos tunnuksesi on jo liitetty toiseen organisaatioon, sinun täytyy luoda uusi.
Liity olemassa olevaan organisaatioon
Vaihe 1: pyydä organisaatiosi ylläpitäjää lähettämään sinulle kutsu.
Jos yrityksellesi on jo luotu organisaatio, pyydä organisaation ylläpitäjää kutsumaan sinut. Sinulla on 24 tuntia aikaa hyväksyä kutsu. Jos et ehdi liittyä annetussa ajassa, voit pyytää uuden kutsun.
Vaihe 2: hyväksy kutsu.
Voit hyväksyä kutsun joko kirjautumalla sisään olemassa olevalla käyttäjätunnuksellasi ja salasanallasi tai luomalla uudet, jos olemassa oleva käyttäjätunnuksesi ja salasanasi on jo liitetty toiseen organisaatioon.
Luo API-projekti
Siirry Omat projektit -sivulle ja avaa API:t-välilehti. Napsauta Luo API-projekti -painiketta.
Vaihe 1: valitse API (API:t), jotka haluat sisällyttää projektiisi
Tarkista API:n kiintiöt, tapahtumamäärärajoitukset ja API:n vahvistustiedot.
Vaihe 2: määritä projektin tiedot
- Anna projektillesi tunnistettavissa oleva nimi, joka liittyy erityisesti organisaatioosi.
- Valitse maat, joissa aiot tehdä lähetyksiä, jotta sinulle voidaan määrittää testitunnukset. Jotta voit testata pakettien lähettämistä yhden maan sisällä Euroopassa eli tehdä kotimaan lähetyksiä, jokaisella maalla pitää olla erillinen testitunnus. Maita voi lisätä ja poistaa myöhemmin.
- Voit saada ilmoituksia viimeisimmistä API-päivityksistä ja kaikista katkoksiin liittyvistä tiedoista muokkaamalla ilmoitusasetuksia.
Vaihe 3: lue ja hyväksy ehdot, mukaan lukien FedEx Developer Portalin käyttöoikeussopimus
Kun olet hyväksynyt ehdot ja napsauttanut Luo-painiketta, näyttöön avautuu vahvistusikkuna. Sen jälkeen voit tarkastella testitunnistetietojasi uudessa projektissasi.
Luo webhook-projekti
Ennakkoedellytykset
- Tarkista hinnat: Tilaajilta veloitetaan kuukausimaksu seurantanumeroiden määrän mukaan. Lue lisätietoja hinnoista hinnoitteluoppaasta.
- Avaa asiakkuudet: Laajennettu integroitu näkyvyys ‑webhookia varten tarvitaan Yhdysvalloissa oleva laskutusasiakasnumero ja vähintään yksi lähettäjän asiakasnumero. Nämä asiakasnumerotyypit ovat toisensa poissulkevia. Vain ylläpitäjät voivat lisätä laskutettavan ja lähettäjän asiakasnumeron Hallitse organisaatiota ‑sivulle.
Luo kelvollinen URL-osoite (vastakutsun URL-osoite) kohdesovelluksessasi tai alustallasi
Kohde-URL-osoitettasi käytetään FedExin lähettämien todennuskoodien ja -viestien sekä webhook-hyötykuorman ilmoitusten vastaanottamiseen. Turvallisuuden varmistamiseksi URL-osoitteessasi on käytettävä HTTPS-protokollaa. URL-osoitteesi estetään, jos se sisältää seuraavaa:
- IP-osoiteavaruus RFC1918
- verkkotunnus fedex.com ja sen aliverkkotunnukset
- IP-osoitteet URL-osoitteessa (mukaan lukien localhost, 127.0.0.1).
Luo suojaustunniste
Tätä suojaustunnistetta voi käyttää salaisena avaimena, jolla todennetaan ja vahvistetaan organisaatiosi ja FedExin välillä siirrettävät tiedot. Suojaustunnisteessasi on oltava:
- Pituus vähintään 26 merkkiä ja enintään 100 merkkiä
- yksi iso kirjain
- yksi pieni kirjain.
- 1 numero
Esimerkki: Y1F6OiVUQW2JPSElmRE9U0IY5
Kun olet määrittänyt URL-osoitteesi ja suojaustunnisteesi, olet valmis luomaan webhook-projektin. Siirry Omat projektit -sivulle ja avaa Webhooks-välilehti. Napsauta Luo webhook-projekti -painiketta.
Valitse tilaustyyppi
FedEx-lähettäjät voivat tilata tapahtumiaan asiakasnumeroiden tai seurantanumeroiden mukaan.
Vaihe 1: vahvista laskutusasiakasnumerosi ja valitse ominaisuudet
- Tarkista listalla näkyvä oletusarvoinen laskutusasiakasnumero vahvistaaksesi sen tai valitse organisaatiostasi toinen laskutusasiakasnumero.
- Määritä projektisi valitsemalla ominaisuuksia, kuten toimitustodistusvaihtoehdot, arvioidut toimitusvaihtoehdot, seurantatapahtumat ja tapahtumapohjainen suodatus.
Vaihe 2: anna projektin tiedot
- Anna projektillesi tunnistettavissa oleva nimi, joka liittyy erityisesti organisaatioosi.
- Anna kohde-URL-osoitteesi ja suojaustunnisteesi tiedot, jotka loit asetusten määritystä edeltävän todennuksen aikana (katso yllä olevat vaiheet).
- Saat ilmoituksia uusimmista webhook-päivityksistä ja katkoksiin liittyvistä tiedoista antamalla sähköpostiosoitteesi ja haluamasi kielen.
Vaihe 3: lue ja hyväksy ehdot
Vahvistusnäyttö avautuu, kun olet hyväksynyt ehdot, mukaan lukien FedEx Developer Portalin käyttöoikeussopimuksen ja tilauslomakkeen, ja napsauttanut Luo-painiketta.
Valitsemastasi tilaustyypistä riippuen toimintoon voi liittyä lisävaiheita. Saat lisätietoja käymällä dokumentaatio-sivulla.
Nouda API-projektin yhteenveto -sivulta testitunnistetietosi — API-avaimesi, salainen avain ja lähettäjän asiakasnumero (-numerot) — Testiavain-välilehdestä.
Vaihe 1: pyydä OAuth-käyttötunniste
OAuth-käyttötunnistetta on käytettävä jokaisen API-tapahtuman yhteydessä. Tunnus on voimassa vain tunnin ajan, joten sovellus pitää koodata ohjelmallisesti tunnuksen päivittämiseksi ennen istunnon päättymistä. Saat lisätietoja API Authorization -dokumentaatio -sivulta.
Vaihe 2: tarkista API-dokumentaatio
Napsauta kunkin API:n dokumentaatiota, niin voit lukea liiketoimintakontekstin ja ymmärtää, miten API:a käytetään. Kirjaudu sisään, jotta voit ladata JSON API -kokoelman dokumentaatiosivun yläosassa olevan painikkeen kautta. Voit myös tarkastella esimerkkipyyntöjä päätepisteelle, joka sopii valitsemaasi integraatioon.
Vaihe 3: testaa esimerkkitapahtumia testiympäristössä
Voit siirtyä tiettyyn testiympäristöön napsauttamalla haluamaasi päätepistettä vasemmassa siirtymispalkissa. Tunnista käyttötapaustasi vastaavat esimerkkipyynnöt ja toteuta sitten päätepistekutsusi esimerkkipyynnöissä kuvatulla tavalla testitunnistetietojasi ja FedExin testi-URL-osoitteita käyttäen. Varmista, että vastaanotetut API-kutsuvastaukset vastaavat asiakirjoissa esitettyjä kutsuvastauksia. Lue lisää testauskokemuksesta testiympäristön oppaasta.
Webhookien testaaminen
Testaamalla saat paremman käsityksen siitä, onko luomasi URL-osoite kelvollinen. Siten FedEx voi tunnistaa URL-osoitteesi ja luoda siihen yhteyden tietojen lähettämistä varten. Testaamalla voit myös saada esimerkkejä testitiedoista, joiden avulla voit tarkistaa ja vahvistaa, pystytkö käsittelemään sovelluksen seurantatietoja. Testaaminen ei kuitenkaan todenna URL-osoitettasi. Katso webhook-dokumentaatiosta, miten webhookin URL-osoitteen voi testata.
Siirry Projektin yhteenveto -sivulle ja avaa Tuotantoavain-välilehti. Asiakasnumerotilaukseen perustuvia laajennettu integroitu näkyvyys -projekteja ei tarvitse siirtää tuotantoon.
Vaihe 1: määritä projekti
- Nimeä avaimesi uudelleen tarpeen mukaan.
- Tarkista projektin luontikulun vaiheessa 1 valittu asiakasnumero. Sitä käytetään projektisi tuotantoon siirtämiseen. Kun projektisi on käynnissä tuotannossa, voit tarvittaessa lisätä muita asiakasnumeroita.
Vaihe 2: hanki projektin avaimet
Kopioi tuotannon API-avaimesi, niin tuotannon salainen avain näkyy turvallisessa paikassa. Jotta tuotannon salainen avaimesi pysyy turvassa, näytämme sen vain kerran. Jos kadotat sen, voit luoda uuden.
Kun olet saanut projektisi avaimet ja napsauttanut Seuraava-painiketta, näet projektisi tiedot Tuotantoavain-välilehdessä.
- Lisää projektiisi lähettäjän asiakasnumeroita napsauttamalla lähettäjän asiakasnumerot -taulukon yläreunassa Muokkaa-painiketta.
Vahvistusvaiheet vaihtelevat alueittain
Seuraavat vaiheet koskevat vain Yhdysvalloissa ja Kanadassa sijaitsevia asiakkaita. Jos asut näiden maiden ulkopuolella, löydät tukea API:n vahvistussivulta.
Jotkut API:t edellyttävät osoitelapun vahvistusta, jotta niitä voidaan käyttää tuotantoympäristössämme. Katso, edellyttääkö API:si vahvistusta.
Vaihe 1: Kehitä ja testaa FedExin API:t verkkosovelluksessasi
Kun verkkosovellus on saatu valmiiksi, se testataan testitunnuksia käyttäen (testaa asiakasnumerot, API-avain ja salainen avain). Testin API-avain ja salainen avain ovat koko ajan näkyvissä hankkeen yleiskuvaussivulla.
Vaihe 2: Siirrä hanke tuotantoon
Kun testaus FedExin APIen kanssa on suoritettu, aloita vahvistusprosessi siirtämällä hanke tuotantoon FedEx Developer Portalissa. Kun se on suoritettu onnistuneesti, tuotannon API-avain ja salainen avain tulevat näkyviin. Salainen avain näkyy vain kerran, mutta se on mahdollista muodostaa uudelleen myöhemmin.
Vaihe 3: Täytä lapun kansiarkki
Täytä osoitelapun kansilehteen kaikki yhteystiedot sekä tiedot toteutettavaksi aiotuista palveluista. Liitä mukaan asiakasnumero ja tuotantoavain.
Vaihe 4: luo ja lähetä testiosoitelaput viivakoodien analysointiryhmälle
Luo testiosoitelaput FedExin testiympäristössä, joka on liitetty sovellukseen, ja lähetä testiosoitelaput FedExin osoitelappujen analysointitiim(e)ille hyväksyttäviksi. Viivakoodien analysointiryhmä tarvitsee kolme arkipäivää osoitelappujen arviointiin.
Noudata näitä parhaita käytäntöjä välttääksesi käsittelyssä ilmenevät viiveet:
- Osoitelaput pitää tulostaa ja skannata vähintään 600 DPI:n tarkkuudella. ÄLÄ LÄHETÄ API:en LUOMIA TIEDOSTOJA.
- Jos käytetään lämpötulostimia, osoitelapun kuvatyypin pitää vastata tulostimen mallia. Esimerkki: ZPLII, kun käytetään Zebra-tulostimia.
- Käytä lähettäjän/vastaanottajan osoitetietoja, kun luot mallilaput arvioitavaksi. Luo mallilaput vain niihin palveluihin, jotka ollaan toteuttamassa. Luo mallilaput vain niihin palveluihin, jotka ollaan toteuttamassa.
- FedEx®-osoitelapussa, jonka tyyppi on käteismaksu toimituksen yhteydessä, pitää olla mukana saman tyyppinen maksetaan toimitettaessa -palautuksen osoitelappu.
- FedEx International Express® -lähetyksissä pitää olla myös avustava lentorahtikirjan (AWB) osoitelappu.
- Moniosaisissa lähetyksissä (MPS) pitää olla yksi lappu jokaiselle lähetyksen paketille.
- Lähetä PDF ja osoitelapun kansilehti sähköpostitse osoitteeseen label@fedex.com.
- Fyysiset laput lähetetään alla olevaan osoitteeseen:
FedEx-palvelut
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017 USA
Jos skannatuissa osoitelapuissa ei ole silmin nähtäviä vikoja (kuten viivakoodin päälle tulostuneita viivoja, musteläiskiä tai fyysisiä vikoja), ne saattavat läpäistä tarkastuksen, jolloin ne hyväksytään.
Jos lähetät fyysisiä lappuja, kiinnitä huomiota tulostuslaatuun ja vahingossa tapahtuviin lappujen kokomuutoksiin (esim. skaalautumiseen). Nämä ovat kaksi yleisintä syytä osoitelappujen hylkäämiseen arviointiprosessissa.
Vaihe 5: tarkista osoitelapun arviointi
Viivakoodin analysointiryhmä arvioi lähetetyt testilaput ja joko hyväksyy tai hylkää ne. Viivakoodien analysointiryhmä ottaa sinuun yhteyttä, ja kertoo lähetettyjen lappujen hyväksymisestä tai hylkäämisestä. Jos laput hyväksytään, jatka seuraavaan vaiheeseen. Jos laput hylätään, korjaa laput ohjeiden mukaan ja lähetä ne hyväksyttäväksi uudelleen.
Vaihe 6: ota sovellus käyttöön
Kun viivakoodien analysointiryhmä on hyväksynyt testiosoitelaput tuotantokäyttöön, saat tuotannon tunnistetiedoillesi oikeuden lähettää tunnistetun osoitelapputapahtuman, ja lisäksi saat sähköpostitse ilmoituksen onnistuneesta vahvistuksesta. Hyväksyntä on projektikohtainen.
Vaihe 7: Vaihda URL ja tunnistetiedot
Korvaa testin URL-osoite ja tunnistetiedot tuotannon URL-osoitteella ja tunnistetiedoilla. Testaa toimeenpano uudelleen tuotantoympäristössä näytetietoja käyttäen.
Edellytys
Yrityksen on jo oltava FedEx Compatible Provider. Jos yrityksesi ei kuulu Compatible-ohjelmaan, muuta valinnaksi yllä ”Non-Compatible Provider”.
Vaihe 1: vastaanota organisaatioon liittymistä koskeva kutsu
FedEx luo organisaation ja kutsuu sitten yhden tiimin jäsenen liittymään organisaatioon. Käyttäjä määritetään organisaatiosi ylläpitäjäksi.
Vaihe 2: hyväksy kutsu
Voit hyväksyä kutsun joko kirjautumalla sisään olemassa olevalla käyttäjätunnuksellasi ja salasanallasi tai luomalla uudet, jos olemassa oleva käyttäjätunnuksesi ja salasanasi on jo liitetty toiseen organisaatioon.
Vaihe 3: kutsu käyttäjiä
Ylläpitäjä voi kutsua käyttäjiä liittymään omaan organisaatioonsa ja määrittää heille rooleja ja projekteja. Avaa Käyttäjät-välilehti. Napsauta Lisää käyttäjiä -painiketta.
- Valitse käyttäjän rooli: Katsoja, Avustaja tai Ylläpitäjä. Lue lisää rooleista Organisaation hallintaoppaasta.
- Jos sinulla on olemassa olevia projekteja, määritä käyttäjälle projekti. Voit myös määrittää käyttäjiä projekteihin millä tahansa Projektin yhteenveto -sivulla.
- Anna niiden käyttäjien sähköpostiosoitteet, joiden haluat liittyvän organisaatioosi valitun roolin alaisuudessa.
Siirry API-luettelo -sivulle ja määritä ratkaisuusi sopivat API:t tai webhookit. FedExin Customer Technology Consultant (CTC) ja Compatible Channel Manager voivat auttaa valitsemaan ratkaisuusi sopivat API:t liiketoimintasi tarpeiden mukaan.
Vaihe 1: täytä tuotetietolomake
Palaa Compatible Provider Communityyn (CPC) ja täytä tuotetietolomake (PIW).
Vaihe 2: tarkista FedExin luoma projekti (projektit)
Kun tuotetietolomake on hyväksytty, FedEx luo projektisi. Kullakin ratkaisujesi versiolla on erillinen projekti FedEx Developer Portalissa.
Vaihe 3: osallistu API:n esittelyyn tiimisi kanssa
FedExin Compatible-tiimi sekä FedEx CTC- ja varmennustiimit järjestävät API:en teknisen esittelyn tiimillesi. FedEx-tiimi keskustelee Compatible-ohjelman varmentamisesta, API:n uusista ominaisuuksista ja toiminnoista sekä vastaa kysymyksiin.
Nouda API-projektin yhteenveto -sivulla testitunnistetietosi — API-avain ja salainen avain — Testiavain-välilehdestä.
Vaihe 1: luo asiakasavaimet
Luo asiakasavaimet Tunnistetietojen rekisteröinti -API:ssa. Se on yksityinen API, joka löytyy vain API-projektin yhteenveto -sivun alareunassa olevasta API-osiosta.
Vaihe 2: pyydä OAuth-käyttötunniste
OAuth-käyttötunnistetta on käytettävä jokaisen API-tapahtuman yhteydessä. Tunnus on voimassa vain tunnin ajan, joten sovellus pitää koodata ohjelmallisesti tunnuksen päivittämiseksi ennen istunnon päättymistä. Saat lisätietoja API Authorization -dokumentaatio -sivulta. Kun tarkastelet näytekoodia, varmista, että ”Jälleenmyyjä” on valittuna näytteiden avattavasta valikosta.
Vaihe 3: tarkista API-dokumentaatio
Napsauta kunkin API:n dokumentaatiota, niin voit lukea liiketoimintakontekstin ja ymmärtää, miten API:a käytetään. Kirjaudu sisään, jotta voit ladata JSON API -kokoelman dokumentaatiosivun yläosassa olevan painikkeen kautta. Voit myös tarkastella esimerkkipyyntöjä päätepisteelle, joka sopii valitsemaasi integraatioon.
Vaihe 4: testaa esimerkkitapahtumia testiympäristössä
Voit siirtyä tiettyyn testiympäristöön napsauttamalla haluamaasi päätepistettä vasemmassa siirtymispalkissa. Tunnista käyttötapaustasi vastaavat esimerkkipyynnöt ja toteuta sitten päätepistekutsusi esimerkkipyynnöissä kuvatulla tavalla testitunnistetietojasi ja FedExin testi-URL-osoitteita käyttäen. Varmista, että vastaanotetut API-kutsuvastaukset vastaavat asiakirjoissa esitettyjä kutsuvastauksia. Lue lisää testauskokemuksesta testiympäristön oppaasta.
Vaihe 5: vahvista jokainen ratkaisu
Kun olet testannut ratkaisusi kaikilta osin, lähetä testitapaukset varmennustiimille kunkin ratkaisun varmentamista varten. FedEx tarkistaa kaikki lähetetyt tiedot ja ilmoittaa, kun varmennus on hyväksytty.
Webhookien testaaminen
Jos organisaatiollasi on pääsy webhookeihin, testaamalla saat paremman käsityksen siitä, onko luomasi URL-osoite kelvollinen. Siten FedEx voi tunnistaa URL-osoitteesi ja luoda siihen yhteyden tietojen lähettämistä varten. Testaamalla voit myös saada esimerkkejä testitiedoista, joiden avulla voit tarkistaa ja vahvistaa, pystytkö käsittelemään sovelluksen seurantatietoja. Testaaminen ei kuitenkaan todenna URL-osoitettasi. Katso webhook-dokumentaatiosta, miten webhookin URL-osoitteen voi testata.
FedEx siirtää tämän jälkeen projektin (projektit) tuotantoon. Siirry API-projektin yhteenveto -sivulle ja avaa Tuotantoavain-välilehti. Napsauta Luo salainen avain -linkkiä Salainen avain -sarakkeessa.
Voit nyt testata toimeenpanon uudelleen tuotantoympäristössä näytetietoja käyttäen.
Edellytys
FedEx Developer Portaliin kirjautumiseen ja organisaation luomiseen tarvitaan FedEx-käyttäjätunnus ja asiakasnumero.
Luo yrityksellesi organisaatio, jollei sitä vielä ole, tai liity yrityksen olemassa olevaan organisaatioon.
Luo uusi organisaatio
Napsauta siirtymispalkissa Luo organisaatio tai liity organisaatioon.
Huomautus: organisaation luojana sinut määritetään automaattisesti organisaation ylläpitäjäksi.
Ylläpitäjät voivat
kutsua käyttäjiä liittymään
määrittää käyttäjille rooleja (esim. avustaja tai katsoja) ja hankkeita
hallita asiakasnumeroita.
Lisätietoja näistä rooleista on organisaation hallintaoppaassa.
Valitse yrityksen tyypiksi ”Yritys myy tai tarjoaa FedExin teknologiaa hyödyntävää ohjelmistoratkaisua, ja se on vahvistettu FedEx Integrator Provider”.
Anna yrityksen nimi, verkkosivuston URL-osoite ja yksilöllinen organisaation nimi. Organisaation nimi voi olla sama kuin yrityksesi nimi tai edustaa tiettyä ryhmää (osasto, jaosto, alue, sijainti). Nämä tiedot ovat tarpeen pyyntösi vahvistamiseksi.
Huomautus: valitse organisaatiolle nimi, jonka kaikki muut käyttäjät tunnistavat (esim. yrityksen nimi, osasto, alue, sijainti).
Määritä yrityksesi sijainti ja missä ohjelmistoratkaisuasi myydään tai jaellaan.
Lisää laskutettava asiakasnumero ja todenna asiakasnumero
Huomautus: FedEx Integrator ‑ohjelman lähetys- ja logistiikkapalveluntarjoajana sinun on käytettävä omaa asiakasnumeroasi. Et voi käyttää asiakkaan FedEx-asiakasnumeroa.
Anna FedEx-asiakasnumerosi. Jos sinulla ei ole olemassa olevaa FedEx-asiakasnumeroa, luo se osoitteessa fedex.com tai ota yhteys FedExin asiakaspalveluun.
Anna asiakasnumeron kutsumanimi ja asiakasnumeroon liittyvä laskutusosoite. Valitse Seuraava.
Huomautus: Laskutusosoitteen on vastattava tietueitamme tälle asiakasnumerolle. Tämä on organisaatiosi oletusarvoinen laskutettava asiakasnumero.
Organisaatiosi luonnin viimeistely edellyttää asiakasnumeron todennusta. Valitse todennusvaihtoehto (puhelin käytettävissä integraattorille vain Yhdysvalloissa ja Kanadassa, sähköposti, tekstiviesti) ja valitse Seuraava.
Kun olet saanut todennuskoodin, anna se ja valitse Lähetä.
Hyväksy käyttöehdot
Lue FedExin integraattorisopimus ja ohjelman opas. Vahvista ehtojen hyväksyminen valitsemalla valintaruudut ja valitse sitten Hyväksy.
Vahvistusnäyttö tulee näkyviin. Muokkaa tietoja tarvittaessa napsauttamalla Hallitse organisaatiota.
Kutsu käyttäjiä
Huomautus: vain ylläpitäjät voivat kutsua käyttäjiä.
Valitse vasemmanpuoleisesta siirtymispalkista Hallitse organisaatiota.
Siirry Käyttäjät-välilehdelle ja valitse Lisää käyttäjiä.
Täytä lomake ja määritä uusille käyttäjille asianmukainen rooli: katsoja, avustaja tai ylläpitäjä.
Lisätietoja käyttäjärooleista on organisaation hallintaoppaassa.
Määritä käyttäjät hankkeisiin (soveltuvissa tapauksissa) avattavasta Hankkeet-valikosta.
Anna kunkin käyttäjän sähköpostiosoite ja valitse sitten Kutsu.
Liity olemassa olevaan organisaatioon
Pyydä kutsua: Pyydä organisaatiosi ylläpitäjää lähettämään sinulle kutsu. Sinulla on 24 tuntia aikaa hyväksyä kutsu ennen kuin se vanhenee. Pyydä ylläpitäjää tarvittaessa lähettämään se uudelleen.
Hyväksy kutsu: Kirjaudu sisään olemassa olevalla käyttäjätunnuksellasi ja salasanallasi. Jos tunnuksesi on jo liitetty toiseen organisaatioon, sinun täytyy luoda uusi.
Luo API-projekti
Siirry Omat hankkeet ‑sivulle ja valitse Luo hanke.
Täytä Hankkeen nimi ‑kenttä. Suositeltu nimen muoto on ”Projektinnimi_sovelluksennimi”. Kun olet valmis, valitse Seuraava.
Valitse hankkeellesi API ja Laajennettu integroitu näkyvyys ‑tuotteet.
Huomautus: Laajennettu integroitu näkyvyys ‑tuotteet ovat saatavilla vain yhdysvaltalaisille FedEx Integrator ‑ratkaisun tarjoajille.
Huomautus: jos valitset maksullisia tuotteita, sinua pyydetään määrittämään projektille laskutettava asiakasnumero ja hyväksymään vaaditut ehdot.
Määritä laskutus ja hyväksy ehdot
Määritä laskutettava asiakasnumero organisaatioon lisättyjen asiakasnumeroiden luettelosta. Tämä vaihe on tarpeen vain, jos valitsit maksullisen tuotteen aiemmin.
Hyväksy tuotteeseen liittyvät palvelun ehdot.
Vahvista tiedot
Tarkista valitut tuotteet. Varmista annettu laskutettava asiakasnumero.
Lue ja hyväksy FedEx Developer Portalin käyttöoikeussopimus.
Luo hanke ja tarkastele testitunnistetietoja napsauttamalla Luo.
Määritä Laajennettu integroitu näkyvyys hankkeessa
Ennakkoedellytykset
Ennakkoedellytykset
- Tarkista hinnat: Tilaajilta veloitetaan kuukausimaksu seurantanumeroiden määrän mukaan. Lue lisätietoja hinnoittelusta tilauslomakkeesta.
- Avaa asiakkuudet: Laajennettua integroitua näkyvyyttä varten tarvitaan Yhdysvalloissa oleva laskutusasiakasnumero ja vähintään yksi lähettäjän asiakasnumero. Nämä asiakasnumerotyypit ovat toisensa poissulkevia. Vain ylläpitäjät voivat lisätä laskutettavan ja lähettäjän asiakasnumeron Hallitse organisaatiota ‑sivulle.
Luo kelvollinen vastakutsun URL-osoite kohdesovelluksessasi tai ‑alustallasi – sovelluksesi/alustasi URL-osoite:
Turvallisuussyistä on käytettävä HTTPS-protokollaa.
Ei voi sisältää IP-osoiteavaruutta RFC1918, fedex.com-aliverkkotunnuksia tai suoria IP-osoitteita (esim. 127.0.0.1).
Luo suojaustunniste
Sen on oltava 26–100 merkkiä pitkä ja sisällettävä
- yksi iso kirjain
- yksi pieni kirjain
- yksi numero.
Esimerkki: Y1F6OiVUQW2JPSElmRE9U0IY5
Määritä Laajennettu integroitu näkyvyys
Valitse Laajennettu integroitu näkyvyys. Valitse ominaisuudet, kuten toimitustodistus, arvioitu toimituspäivä, seurantatapahtumat ja tapahtumapohjainen suodatus.
Anna kohde-URL-osoite ja suojaustunniste.
Anna sähköpostiosoite Laajennetun integroidun näkyvyyden päivityksiä ja katkosilmoituksia varten.
Vahvista tiedot
Lue ja hyväksy FedEx Developer Portal ‑portaalin käyttöoikeussopimus ja tilauslomake.
Viimeistele määritys valitsemalla Luo.
Huomautus: Valitsemastasi tilaustyypistä riippuen tähän voi liittyä lisävaiheita. Katso lisätietoja dokumentaatiosta.
Nouda testitunnistetiedot ja aloita testaus
Tarkista API-dokumentaatio
- Lue API-dokumentaatio, jotta ymmärrät tarjoamamme erilaiset API-rajapinnat sekä niiden liiketoimintakontekstit ja integrointiprosessit.
- Lataa JSON-skeema asianomaisen API:n dokumentaatiosivulta.
- Tarkastele esimerkkipyyntöjä halutuille päätepisteille.
Hanki testitunnistetiedot
Avaa Projektin yhteenveto ‑sivulta API-avaimet ‑välilehti. API-avaimesi ja salainen avaimesi on esitetty Testiavain-otsikon alla.
Tarkista API-dokumentaatio
- OAuth-tunniste vaaditaan kaikille API-tapahtumille, ja se vanhenee yhden tunnin kuluessa.
- Sovelluksesi täytyy päivittää tunniste ennen kuin se vanhenee.
- Katso lisätietoja API-valtuutuksen dokumentaatiosta.
Testaa API-tapahtumat testiympäristössä
- Siirry asiaankuuluvaan API-rajapintaan API-luettelossa ja valitse Dokumentaatio.
- Valitse haluamasi API-päätepiste vasemmanpuoleisesta valikosta.
- Käytä esimerkkipyyntöjä, jotka vastaavat käyttötapaustasi.
- Toteuta API-kutsut käyttäen testitunnistetietojasi ja FedExin testi-URL-osoitteita.
- Tarkista vastaukset vertaamalla niitä dokumentaatioon.
- Lisätietoja on testiympäristön oppaassa.
Laajennetun integroidun näkyvyyden testaus
Laajennetun integroidun näkyvyyden testaus vahvistaa URL-osoitteen muodon ja auttaa luomaan yhteyden FedExin ja sovelluksesi välille.
Testi tarjoaa esimerkkitestidataa seurantatietojen käsittelyyn.
Huomautus: testaaminen ei todenna URL-osoitettasi.
Lisätietoja on Laajennettu integroitu näkyvyys ‑dokumentaatiossa.
API-rajapintojen siirtäminen tuotantoon edellyttää vahvistusta. Vahvistuksen taso vaihtelee API:n mukaan.
Kehitä ja testaa FedExin API-rajapintoja
- Käytä testitunnistetietojasi (API-avainta ja salaista avainta) Projektin yhteenveto ‑sivulta.
- Tunnista testitapaukset niille alueille, joilla aiot ottaa ratkaisusi käyttöön (katso lisätietoja integraattorin testitapausten perustasosta).
- Ennen testitapausten suorittamista suorita rekisteröintitapahtumat käyttämällä annettuja testiasiakasnumeroita.
- Suorita kaikki vaaditut testitapaukset.
Siirry Projektin yhteenveto ‑sivulle.
Valitse Pyydä tuotantoavaimia. FedEx vastaanottaa tuotantoavainten pyyntösi ja ilmoittaa sinulle, kun ne on hyväksytty.
Täytä tuotetietolomake ja vahvistuksen kansilehti
Täytä tuotetietolomake ja integraattorin vahvistuksen kansilehti yhteystiedoillasi ja aiotuilla FedEx-palveluilla.
Lähetä toimitettavat tiedostot
Kerää ja pakkaa seuraavat tiedostot .zip-tiedostoon, jotta vältyt sähköpostin palveluntarjoajan rajoituksilta. Lähetä se osoitteeseen validationmtp@fedex.com.
Vaaditut toimitettavat tiedostot
- Täytetty tuotetietolomake (PDF)
- Täytetty vahvistuksen kansilehti (PDF)
Kuvakaappaukset (PDF):
Asiakkaille suunnattu ratkaisu, jossa FedEx-palvelut/erityiskäsittely ovat näkyvissä
Vastuuvapauslauseke
Loppukäyttäjän käyttöoikeussopimus
Loppuasiakkaan rekisteröintiprosessi
- Loppuasiakkaan rekisteröintitapahtumat monivaiheisella todennuksella (JSON)
- Skannatut osoitelaput kaikille soveltuville testitapauksille (PDF/PNG)
- Lähetystapahtumat kolmelle osoitelappumuodolle: PDF, PNG ja ZPL (JSON) (soveltuville lähetys- ja hinnoittelu-API-rajapinnoille)
Parhaat käytännöt viivästysten välttämiseksi
- Osoitelaput täytyy tulostaa ja skannata vähintään 600 DPI:n tarkkuudella.
- Jos käytetään lämpötulostimia, osoitelappujen on vastattava tulostimen mallia (esim. ZPLII, kun käytetään Zebra-tulostimia).
- FedEx International Express® ‑lähetykset vaativat rahtikirjan lisäosoitelapun.
- Moniosaisissa lähetyksissä (MPS) täytyy olla osoitelappu jokaiselle paketille.
Osoitelapun arviointi
Vahvistustiimi hyväksyy tai hylkää lähetyksesi.
- Jos se hylätään, tee korjaukset ja lähetä uudelleen palautteen perusteella.
- Jos se hyväksytään, saat sähköpostiviestin onnistuneesta vahvistuksesta. Kun olet saanut sähköpostiviestin, tuotannon tunnistetietosi valtuutetaan osoitelapputapahtumiin.
Noudata vahvistuksen jälkeisiä ohjeita
Tarkista ja toteuta kaikki vahvistuksen jälkeiset vaatimukset tarpeen mukaan.
Kun saat ilmoituksen, että tuotantoavaimesi on hyväksytty, nouda tuotantoavaimesi Projektin yhteenveto ‑välilehdeltä.
- Kopioi tuotannon API-avain ja salainen avain ja säilytä niitä turvallisessa paikassa.
- Salainen avain näytetään vain kerran – jos se katoaa, sinun täytyy luoda uusi.
