Alkutoimet
Aloita integraatio hyödyntämällä FedExin API-rajapintoja. Seuraavissa ohjeissa opastetaan, miten organisaatio määritetään ja projekteja luodaan sekä miten päästään alkuun soveltuvana käyttäjänä.
- Selaa ohjelmointirajapintoja ja määritä, mitä sovelluksellesi tarvitaan.
- Rekisteröidy tai kirjaudu sisään ja aloita FedEx-ohjelmointirajapintojen integraatio.
- Luo organisaatio tai liity organisaatioon.
- Lisää asiakasnumero.
- Lisää käyttäjiä organisaatioosi ja aloita yhteistyö tiimisi jäsenten kanssa.
- Luo hanke ja hanki tunnistetiedot.
- Integroi ohjelmointirajapinnat sovellukseesi ja testaa toteutus.
- Siirrä hankkeesi tuotantoon.
- Viimeistele integraatio.
1. vaihe:
Selaa ohjelmointirajapintoja ja määritä, mitä sovelluksellesi tarvitaan.
- Siirry kohtaan API-luettelo ja määritä oikeat ohjelmointirajapinnat sovelluksellesi.
- Valitse ohjelmointirajapinta ja tutustu sen yhteenvetoon, muutoslokiin ja tärkeimpiin ominaisuuksiin.
- Tarkastele ohjelmointirajapintojen asiakirjoja ja lue lisää pyynnöistä ja vastauksista, esimerkeistä valitsemallasi ohjelmointikielellä, virhekoodeista ja paljosta muusta.
- Tarkista suunniteltujen palvelupäivitysten Ilmoitukset ja pysy ajan tasalla.
2. vaihe:
Rekisteröidy tai kirjaudu sisään ja aloita FedEx-ohjelmointirajapintojen integraatio.
- Aloita FedEx-ohjelmointirajapintojen integraatio kirjautumalla sisään fedex.com-käyttäjätunnuksella ja salasanalla.
- Jos sinulla ei ole vielä käyttäjätunnusta, rekisteröidy ilmaiseksi.
3. vaihe:
Luo organisaatio tai liity organisaatioon.
Luo yrityksellesi organisaatio, jollei sitä vielä ole, tai liity yrityksen olemassa olevaan organisaatioon. Yhdessä organisaatiossa voi olla useita käyttäjiä, mutta yhdellä käyttäjätunnuksella ei voi olla useita organisaatioita.
Jos luot organisaatiosi, sinut määritetään automaattisesti organisaatiosi ylläpitäjäksi. Ylläpitäjänä voit kutsua käyttäjiä liittymään organisaatioon, määrittää heille rooleja ja hankkeita sekä hallita asiakasnumeroja. Lue lisää siitä, mikä rooli sopii parhaiten kellekin, kohdasta Organisaation hallinnan periaatteet. Luo oma organisaatiosi napsauttamalla Omat hankkeet ja sitten Luo organisaatio -painiketta. Tämä painike näkyy vain, jollet ole vielä liittänyt käyttäjätunnustasi olemassa olevaan organisaatioon. Sen jälkeen voit luoda organisaation suorittamalla seuraavat toimet (tähdellä merkityt ovat valinnaisia):
- Anna organisaation nimi.
- Syötä niiden tiimin jäsenten sähköpostiosoitteet, jotka haluat kutsua. Ne lisätään automaattisesti katsojiksi, joita ei ole liitetty mihinkään hankkeeseen.*
Voit myös liittyä yrityksesi organisaatioon noudattamalla seuraavia vaiheita:
- Jos yrityksellesi on jo luotu organisaatio, pyydä organisaation pääkäyttäjää kutsumaan sinut liittymään. Sinulla on 24 tuntia aikaa hyväksyä kutsu, mutta jollet ehdi tehdä sitä tässä ajassa, voit pyytää uutta kutsua.
- 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.
4. vaihe:
Lisää asiakasnumero.
Ylläpitäjä voi lisätä tarvittavan määrän asiakasnumeroja organisaation alle. Aloita napsauttamalla Lisää asiakasnumero -painiketta Asiakasnumerot-välilehdellä Hallitse organisaatiota -sivulla. Sieltä voit lisätä olemassa olevan asiakasnumeron organisaatioosi noudattamalla seuraavia vaiheita:
- Asiakastietojen syöttäminen
Anna asiakasnumerosi, mahdollinen lempinimi ja asiakasnumeroon liittyvä laskutusosoite. Nämä tiedot tarkistetaan, jotta voidaan varmistaa, että tiedot sopivat yhteen asiakasnumeron tietojen kanssa. Näin vältytään vilpiltä.
Katso käyttäjätunnukseesi liitetyt lähettäjän asiakasnumerot lähetysten hallinnan sivulta. Luo uusia asiakasnumeroita ottamalla yhteyttä FedExin myyntiedustajaan.
- Loppukäyttäjän käyttöoikeussopimus
Sen jälkeen sinun pitää hyväksyä tai lähettää hyväksyttäväksi Loppukäyttäjän käyttöoikeussopimus (EULA). Voit tarkastella loppukäyttäjän käyttöoikeussopimussopimuksen tilaa Asiakasnumerot-välilehdellä Hallitse organisaatiota -sivulla.
5. vaihe:
Lisää käyttäjiä organisaatioosi ja aloita yhteistyö tiimisi jäsenten kanssa.
Ylläpitäjä voi kutsua käyttäjiä liittymään organisaatioon ja määrätä heille rooleja sekä hankkeita. Napsauta ensin Lisää käyttäjiä -painiketta Käyttäjät-välilehdellä Hallitse organisaatiota -sivulla. Sen jälkeen voit lisätä käyttäjiä suorittamalla seuraavat toimet (tähdellä merkityt ovat valinnaisia):
- Syötä organisaatioosi liittyvien käyttäjien sähköpostiosoitteet. Syötä useampia sähköpostiosoitteita käyttämällä näppäimistön välilyönti-, pilkku-, puolipiste- tai enter -painiketta.
- Valitse rooli, jos oletusasetuksena annettu Katsoja-rooli ei sovi käyttäjän tarpeisiin.*
- Valitse organisaatioosi liitetty hanke, johon haluat määrittää käyttäjiä. Jollet ole luonut sitä, se hoituu seuraavassa vaiheessa.*
Ylläpitäjällä on aina käyttöoikeus kaikkiin hankkeisiin, mutta avustaja ja katsoja pitää nimittää hankkeeseen, ellei avustaja ole luonut hanketta. Olipa käyttäjä hyväksynyt kutsun tai ei, voit aina päivittää heidän hankkeensa tai roolinsa nopeasti suoraan Käyttäjät-välilehdellä Organisaation hallinta -sivulla. Sinun tarvitsee vain napsauttaa roolin tai hankkeen vieressä olevaa poisjääntimerkkiä, ja näyttöön ilmestyy avattava valikko, josta voit valita sopivan vaihtoehdon. Tee valinta ja tallenna valinta painamalla Käytä-painiketta.
6. vaihe:
Luo hanke ja hanki tunnistetiedot.
Omat hankkeet -sivulla ylläpitäjä tai avustaja voi luoda hankkeen valitsemalla Luo hanke -painikkeen. Sen jälkeen he voivat luoda hankkeen seuraavia vaiheita noudattamalla (tähdellä merkityt ovat valinnaisia):
1. Luo hanke
- Anna hankkeellesi tunnistettavissa oleva nimi, joka liittyy erityisesti organisaatioosi.
- Aloita valitsemalla vähintään yksi hankkeeseen lisättävä ohjelmointirajapinta. Voit lisätä tai poistaa ohjelmointirajapintoja myöhemmin.
2. Hyväksy käyttöehdot
- Lue ja hyväksy Developer Portal käyttöoikeussopimus ja hyväksy, ettet aio jakaa sovellustasi.
- Valitse kaikki maat, joiden sisällä aiot tehdä lähetyksiä, jotta voimme määrittää sinulle testiasiakasnumeron. Jotta voit testata pakettien lähettämistä yhden maan sisällä Euroopassa, jokaisella maalla pitää olla erillinen testitunnus. Maita voi lisätä/poistaa jälkeenpäin.*
- Jos aiot käyttää FedEx Ground® Economy Returns tai FedEx Freight® LTL -palveluita, valitse Kyllä.*
- Napsautettuasi Luo-painiketta näyttöön avautuu vahvistusikkuna. Voit nyt tarkastella testitunnistetietojasi uuden hankkeen sisällä.
7. vaihe:
Integroi ohjelmointirajapinnat sovellukseesi ja testaa toteutus.
- Nouda testitunnistetietosi (API-avain, salainen avain ja asiakasnumero(t)) Hankkeen näkymä -sivun Testiavain-välilehdeltä.
- Pyydä OAuth-hakutunnusta, jota pitää käyttää jokaisessa ohjelmointirajapinnan tapahtumassa. Tunnuksen istunto on voimassa vain tunnin ajan, joten sovellus pitää koodata ohjelmallisesti tunnuksen päivittämiseksi ennen istunnon päättymistä. Katso lisätietoja API-valtuutuksen asiakirjoista.
- Valitse ohjelmointirajapintojen asiakirjat Testiavain-sivulta ja lue sisältö, jotta ymmärrät, miten valittuja ohjelmointirajapintoja käytetään. Tarkastele esimerkkipyyntöjä päätepisteelle, joka sopii valitsemallesi integraatiolle.
- Toteuta puhelut näihin päätepisteisiin esimerkkipyynnöissä kuvatulla tavalla ja konfiguroi ne käyttämään testitunnistetietoja.
- Vahvista, että vastaanotetut API-kutsuvastaukset ovat yhteensopivia asiakirjoissa näytettyjen vastausten kanssa.
- Testaa toteutuksesi läpikotaisin FedEx-testiympäristössä testitunnistetietoja ja FedEx-testi-URL-osoitetta käyttäen.
8. vaihe:
Siirrä hankkeesi tuotantoon.
Hankkeen yhteenveto -sivulla napsauta Tuotantoavain-välilehteä. Sen jälkeen voit aloittaa hankkeen siirtämisen tuotantoon seuraavia vaiheita noudattamalla (tähdellä merkityt ovat valinnaisia):
- Määritä hanke.
- Nimeä Tuotannon API-avain uudelleen.*
- Tässä vaiheessa vaaditaan yksi asiakasnumero, mutta niitä voi lisätä myöhemmin sen jälkeen, kun hanke on siirretty tuotantoon. Jos organisaatioosi ei ole määritetty mitään asiakasnumeroja tai jos loppukäyttäjän käyttöoikeussopimusta ei ole hyväksytty organisaatioosi lisätyille asiakasnumeroille, ne eivät näy avattavassa valikossa.
- Hanki hankkeen avaimet.
- Seuraavaksi näytössä näkyvät tuotannon API-avain ja salainen avain. Muista kopioida ne talteen johonkin varmaan paikkaan.
- Pitääksemme tuotannon salaisen avaimesi turvassa, näytämme sen vain kerran. Jos hävität sen, voit luoda uuden.
9. vaihe:
Viimeistele integraatio.
- Jotkut ohjelmointirajapinnat tarvitsevat joko perus- tai osoitetarran kelpuutuksen, jotta niitä voidaan käyttää tuotantoympäristössämme. Viimeistele kelpuutusprosessi kaikille hankkeesi ohjelmointirajapinnoille.
- Sen jälkeen kun kaikki ohjelmointirajapinnat on kelpuutettu ja otettu käyttöön, päivitä API-pyyntösi korvaamalla testi-URI-osoitteet, avaimet ja asiakasnumerot tuotannon URI-osoitteilla, avaimilla ja asiakasnumeroilla.
- Testaa toimeenpano uudelleen tuotantoympäristössä näytetietoja käyttäen.
- Käytä uuden integraation hyödyt hyväksesi!
Etkö ole kehittäjä tai etkö tiedä, oletko valmis aloittamaan FedEx-ohjelmointirajapintojen integraation? Lue lisää mahdollisuuksista, joita integrointi voi tarjota yritystoiminnallesi.
- FedEx luo Compatible -ratkaisun toimittajan organisaation.
- Hyväksy kutsu.
- Kutsu käyttäjiä organisaatioosi.
- Valitse APIt, jotka tarvitset ratkaisuusi.
- FedEx luo hankkeen/hankkeet.
- Integroi APIt sovellukseesi ja sertifioi Compatible-ohjelmaan.
- FedEx siirtää hankkeen/hankkeet tuotantoon.
- Luo tuotannon salainen avain.
1. vaihe:
FedEx luo Compatible -ratkaisun toimittajan organisaation.
- FedEx luo organisaation ja kutsuu sitten yhden tiimin jäsenen liittymään organisaatioon. Tämä käyttäjä määritetään organisaatiosi pääkäyttäjäksi.
- Kun sertifiointi ja integraatio on suoritettu, voit jakaa ratkaisun asiakkaillesi helposti.
2. vaihe:
Hyväksy kutsu.
- Pääset käyttämään API-integraation artefakteja ja asiakirjoja hyväksymällä kutsun. Voit hyväksyä kutsun joko kirjautumalla sisään FedEx-käyttäjätunnuksellasi ja -salasanallasi tai luomalla uuden tunnuksen, jos sinulla ei vielä ole sellaista.
3. vaihe:
Kutsu käyttäjiä organisaatioosi.
- Pääkäyttäjänä voit kutsua jäseniä, jotka tarvitsevat hankkeen tai organisaation käyttöoikeuden. Saat lisätietoja eri rooleista organisaation hallintaoppaasta.
- Jos organisaatiosi on jo luotu, pyydä organisaation pääkäyttäjää tai FedExiä kutsumaan sinut liittymään. Sinulla on 24 tuntia aikaa hyväksyä kutsu, mutta jollet ehdi tehdä sitä tässä ajassa, voit pyytää uutta kutsua.
4. vaihe:
Valitse APIt, jotka tarvitset ratkaisuusi.
Siirry kohtaan API-luettelo ja määritä oikeat APIt sovelluksellesi. FedExin Customer Technology Consultant (CTC) ja Compatible Channel Manager voivat auttaa valitsemaan ratkaisullesi sopivat APIt liiketoimintasi tarpeiden mukaan.
Valitse API ja tutustu sen yhteenvetoon, muutoslokeihin ja tärkeimpiin ominaisuuksiin.
Tarkastele APIn asiakirjoja ja lue lisää pyynnöistä ja vastauksista, esimerkeistä valitsemallasi kielellä, virheobjekteista ja muista asioista.
Siirry takaisin Salesforceen täyttämään tuotetietolomake (PIW) ja luettele APIt, jotka haluat lisättävän ratkaisuusi.
5. vaihe:
FedEx luo hankkeen/hankkeet.
Kun tuotetietolomake on hyväksytty, FedEx luo hankkeesi. Kullakin ratkaisujesi versiolla on erillinen hanke FedEx Developer Portalssa. Muut kuin organisaation pääkäyttäjät tarvitsevat kutsun voidakseen tarkastella hankkeita.
Tässä vaiheessa FedExin Compatible-tiimi sekä CTC- ja sertifiointitiimit järjestävät APIen teknisen esittelyn tiimillesi. FedEx-tiimi kertoo, mitä uusia ominaisuuksia ja toimintoja on tarjolla APIen versiossa, jota olet ottamassa käyttöön. Tiimi voi myös vastata teknisiin kysymyksiin, jotka koskevat API-ohjelmointirajapintoja, niiden testausta sekä kaikkia prosesseja, jotka on suoritettava APIen sertifiointiprosessin* aloittamista varten.
*Sertifiointi – FedExin Compatible-ohjelman määrittämä prosessi, jolla varmistetaan ohjelman vaatimusten noudattaminen. Compatible-ohjelman sertifioinnilla varmistetaan, että kaikki Compatible-ratkaisun toimittajat noudattavat FedExin teknologia- ja palvelustandardeja käyttäessään FedEx-teknologiaa ja markkinoidessaan ja jakaessaan sitä lähettäjille (asiakkaille).
6. vaihe:
Integroi APIt sovellukseesi ja sertifioi Compatible-ohjelmaan.
- Voit nyt käyttää API-avaimen ja salaisen avaimen testiversioita ja alkaa suorittaa tapahtumia. Nouda ne Hankkeen yleiskatsaus -sivun Testiavain-välilehdeltä.
- Jotta voisit luoda asiakkaan avaimia sinun on käytettävä tunnistetietojen rekisteröinnin APIa, joka on yksityinen ja löytyy ainoastaan kunkin hankkeen API-osiosta.
- Kun olet luonut joitain asiakkaan avaimia, pyydä OAuth-käyttötunnusta, jota tarvitaan jokaisessa API-tapahtumassa. Tunnuksen istunto on voimassa vain tunnin ajan, joten sovellus pitää koodata ohjelmallisesti tunnuksen päivittämiseksi ennen istunnon päättymistä. Katso lisätietoja API-valtuutuksen asiakirjoista. Kun tarkastelet näytekoodia, varmista, että ”Jälleenmyyjä” on valittuna näytteiden avattavasta valikosta.
- Valitse ohjelmointirajapintojen asiakirjat Testiavain-sivulta ja lue sisältö, jotta ymmärrät, miten valittuja ohjelmointirajapintoja käytetään. Tarkastele esimerkkipyyntöjä päätepisteelle, joka sopii valitsemallesi integraatiolle.
- Toteuta puhelut näihin päätepisteisiin esimerkkipyynnöissä kuvatulla tavalla ja konfiguroi ne käyttämään testitunnistetietoja.
- Vahvista, että vastaanotetut API-kutsuvastaukset ovat yhteensopivia asiakirjoissa näytettyjen vastausten kanssa.
- Testaa toteutuksesi läpikotaisin FedEx-testiympäristössä testitunnistetietoja ja FedEx-testi-URL-osoitetta käyttäen.
- Kun olet testannut ratkaisusi, sertifioi ne Salesforcessa. FedEx tarkistaa kaikki lähetetyt tiedot ja kertoo, kun sertifiointi on hyväksytty.
7. vaihe:
FedEx siirtää hankkeen/hankkeet tuotantoon.
- FedEx siirtää sitten hankkeen/hankkeet tuotantoon.
- Tämän jälkeen näet Production API Keyn Hankkeen yleiskatsaus -sivun Production Key -välilehdellä.
8. vaihe:
Luo tuotannon salainen avain.
- Tuotannon salainen avain on luotava napsauttamalla Salainen avain -kohdan Luo salainen -linkkiä.
- Voit nyt testata toimeenpanon uudelleen tuotantoympäristössä näytetietoja käyttäen.
- Käytä uuden integraation hyödyt hyväksesi!
