1. Luo projekti ja hanki tunnistetiedot.
2. Integroi APIt ja testaa toteutus
3. Siirrä projektisi tuotantoon
4. Viimeistele sertifiointi

Organisaation ylläpitäjä tai avustaja voi luoda API-projektin napsauttamalla Luo API-projekti ‑painiketta.

Ennen aloittamista sinun on kerrottava meille, miksi tarvitset FedEx APIen käyttöoikeuden. Näyttöön avautuu ikkuna, jonka avattavassa valikossa on erilaisia vaihtoehtoja. Valitse vaihtoehto, joka kuvaa parhaiten sitä, miksi yrityksesi tarvitsee FedExin API-integraatiota.

Jos tunnistaudut lähettäjäksi, voit aloittaa projektin luonnin. Prosessi on kolmivaiheinen:

Valitse ohjelmointirajapinnat

Valitse APIt, jotka haluat sisällyttää projektiin. Valitsemistasi API-rajapinnoista riippuen sinun on mahdollisesti tehtävä lisävalintoja.

Jos valitset Track APIn, sinun on myös tehtävä seuraavat:

• Valitse asiakasnumero, johon tuotantoavain liitetään.
• Tarkista Track APIn kiintiöt, tapahtumamäärärajoitukset ja APIn sertifiointitiedot.
• Päätä, haluatko vastaanottaa sähköposti-ilmoituksia, kun tapahtumakiintiö ylittyy.

Määritä hanke

Anna projektin tietoja, kuten nimi ja lähettäjän sijainti.

• 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.

Vahvista tiedot

Tarkista projektin tiedot ja hyväksy sitten Käyttöehdot.

• Lue ja hyväksy FedEx Developer Portalin Käyttöoikeussopimus ja hyväksy, ettet aio myydä tai jakaa sovellustasi.
• Napsautettuasi Luo-painiketta näyttöön avautuu vahvistusikkuna. Sen jälkeen voit tarkastella testitunnistetietojasi uudessa projektissa.

• Voit pyytää OAuth-hakutunnusta, jota on käytettävä jokaisessa API-tapahtumassa. Tunnus on voimassa vain tunnin ajan, joten sovellus pitää koodata ohjelmallisesti tunnuksen päivittämiseksi ennen istunnon päättymistä. Katso lisätietoja API-valtuutuksen asiakirjoista.
• Voit napsauttaa mitä tahansa API-asiakirjoja ja lukea, miten ohjelmointirajapintoja käytetään. Voit myös tarkastella esimerkkipyyntöjä päätepisteelle, joka sopii valitsemaasi integraatioon.
• Voit toteuttaa pyynnöt näihin päätepisteisiin esimerkkipyynnöissä kuvatulla tavalla ja määrittää ne käyttämään testitunnistetietoja.
• Voit vahvistaa, että vastaanotetut API-kutsuvastaukset ovat yhteensopivia asiakirjoissa esitettyjen vastausten kanssa.
• Voit testata toteutuksesi läpikotaisin FedEx-testiympäristössä testitunnistetietoja ja FedEx-testi-URL-osoitetta käyttäen.

Määritä projekti ‑vaiheessa:

• Voit nimetä avaimen tarvittaessa uudelleen.
• 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.

Hanki projektin avaimet ‑vaiheessa:

• Näytössä näytetään tuotannon API-avain ja salainen avain. Muista kopioida ja tallentaa ne varmaan paikkaan.
• Jotta tuotannon salainen avaimesi pysyy turvassa, näytämme sen vain kerran. Jos kadotat sen, voit luoda uuden.
• Napsauta Next (Seuraava).

Järjestelmä siirtyy takaisin Projektin yhteenveto ‑sivulle, jossa voit lisätä muita projektiisi liittyviä asiakasnumeroita.

Projektin yhteenveto ‑sivulla:

• Napsauttamalla kolmea päällekkäin olevaa pistettä voit lisätä muita projektiisi liittyviä asiakasnumeroita.
• Valitse sitten Muokkaa.

Järjestelmä siirtyy API-avain-sivulle, jossa voit lisätä muita asiakasnumeroita, joihin haluat liittää tämän projektin tuotantoavaimen.

1. Jotkut APIt tarvitsevat osoitelapun kelpuutuksen, jotta niitä voidaan käyttää tuotantoympäristössämme. Viimeistele sertifiointiprosessi kaikille projektisi API-rajapinnoille.

1. Kun kaikki APIt on sertifioitu ja otettu käyttöön, päivitä API-pyyntösi korvaamalla testi-URL-osoitteet, avaimet ja asiakasnumerot tuotannon URL-osoitteilla, avaimilla ja asiakasnumeroilla.

2. Testaa toimeenpano uudelleen tuotantoympäristössä näytetietoja käyttäen.

3. Käytä uuden integraation hyödyt hyväksesi!

Webhook-projektin luomisen edellytykset

1. Luo kelvollinen URL-osoite kohdesovelluksessasi/-alustallasi
2. Luo suojaustunniste
3. Testaa webhookin URL-osoite
4. Vahvista kohde-URL-osoite

Luo webhook-projekti

1. Luo webhook-projekti, jotta saat määritetyn hyötykuorman ilmoitukset

Webhook-projektin luomisen edellytykset

Luo kohdesovelluksessasi/-alustallasi kelvollinen URL-osoite, jotta voit saada FedExiltä todennuskoodeja/-viestejä ja seuranta-webhookien hyötykuormailmoituksia.

URL-osoitteen vaatimukset:

Tätä suojaustunnistetta voi käyttää salaisena avaimena, jolla todennetaan ja vahvistetaan sinun (asiakas) ja FedExin välillä siirrettäviä tietoja.

Suojaustunnisteen vaatimukset:

• pituus vähintään 25 merkkiä ja enintään 100 merkkiä
• yksi iso kirjain
• yksi pieni kirjain.
• 1 numero

URL-osoitteen testaaminen on valinnainen vaihe, josta voi olla hyötyä.

Testaamalla saatat saada paremman käsityksen siitä, onko vaiheessa 1 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.

HMAC SHA256 ‑hajautusalgoritmimenetelmää käyttämällä voit määrittää todennusprosessin, jolla vahvistetaan kohde-URL-osoitteesi ja FedExin välillä siirrettävät tiedot.

1. Kun napsautat Luo-painiketta, FedEx luo satunnaisen haastemerkkijonon, joka lähetetään sinulle pyynnön tekstissä. Sinun odotetaan palauttavan haastemerkkijono FedExille vastauksen tekstissä.

1. Alusta viestin todennuskoodi (MAC) käyttämällä HMAC SHA256 ‑algoritmia/-menettelyä haastemerkkijonon ja suojaustunnisteen (tai salaisen avaimen) hajauttamiseen (tai yhdistämiseen), jotta voit muodostaa hajautusallekirjoituksen.

1. Vastaa FedExille vastauksen tekstillä, jossa on challengeString ja challengeStringResponse sekä HTTP-tilakoodi 200 (OK) tai 202 (ACCEPTED).

1. FedEx vahvistaa haastemerkkijonon ja haastemerkkijonon vastauksen.

• Vastauksen tekstin vastaanottamisen jälkeen FedEx vahvistaa kohteet challengeString ja challengeStringResponse (tai aiemmin luodun hajautusallekirjoituksen) vertaamalla sitä FedExin luomaan challengeString-kohteeseen ja hajautusallekirjoitukseen.

• Jos sekä challengeString että HMAC-allekirjoitus täsmäävät, vahvistus ja työnkulku ovat onnistuneet. Muussa tapauksessa vahvistusprosessi epäonnistuu, ja asianmukainen virheilmoitus näytetään.

Luo webhook-projekti

Siirry Omat projektit ‑sivun Webhook-välilehdelle.

Organisaation ylläpitäjä tai avustaja voi luoda webhook-projektin napsauttamalla Luo webhook ‑painiketta.

Ennen aloittamista sinun on kerrottava meille, miksi tarvitset FedEx-webhookien käyttöoikeuden. Näyttöön avautuu ikkuna, jonka avattavassa valikossa on erilaisia vaihtoehtoja. Valitse vaihtoehto, joka kuvaa parhaiten sitä, miksi yrityksesi tarvitsee FedEx-webhookien integraatiota.

Jos tunnistaudut lähettäjäksi, voit aloittaa projektin luonnin seuraavasti:

1. Määritä yrityksesi tarpeet

• Valitse vaihtoehto, joka kuvaa parhaiten sitä, miksi yrityksesi haluaa FedEx-webhookien integraation.

1. Valitse taso ja tason ominaisuudet

• Valitse projektille sen tarpeiden perusteella joko webhook-toiminnon perustaso tai edistynyt taso.
• Tason valintaa voi muokata myöhemmin.
• Jokaiseen tasoon sisältyy kuukausittainen tilausmaksu.

• Valitse ominaisuudet, jotka haluat määrittää projektiin.
• Ominaisuuksia voi muokata myöhemmin.

1. Määritä projektin tiedot

• Anna projektille tunnistettavissa oleva nimi
• Anna asetusten määritystä edeltävän todennuksen aikana luotujen kohde-URL-osoitteen ja suojaustunnisteen tiedot.

Valitse asiakasnumerot

• Valitse kelvollisten (Yhdysvalloissa tai Kanadassa olevien) asiakasnumeroiden luettelosta ne, jotka haluat liittää projektiisi.

  5. Vahvista tiedot ja hyväksy ehdot

• Tarkista määritetyn projektisi tiedot.
• Lue ja hyväksy Developer Portalin käyttöoikeussopimus ja hyväksy, ettet aio jakaa sovellustasi.
• Lue ja hyväksy hintasopimus.
• Luo projekti ‑painikkeen napsauttamisen jälkeen:

1. Jos luontipyyntösi vahvistus ja käsittely onnistui, vahvistusnäyttö avautuu.

• Jos vahvistus epäonnistui, näet virheviestin.

1. Seuranta-webhook-projektillesi luodaan webhook-tunnus, ja sen näytetään olevan aktiivisessa tilassa.

1. FedEx luo Compatible -ratkaisun toimittajan organisaation.
2. Hyväksy kutsu.
3. Kutsu käyttäjiä organisaatioosi.
4. Valitse APIt, jotka tarvitset ratkaisuusi.
5. FedEx luo hankkeen/hankkeet.
6. Integroi APIt sovellukseesi ja sertifioi Compatible-ohjelmaan.
7. FedEx siirtää hankkeen/hankkeet tuotantoon.
8. Luo tuotannon salainen avain.

• FedEx luo organisaation ja kutsuu sitten yhden tiimin jäsenen liittymään organisaatioon. Käyttäjä määritetään organisaatiosi ylläpitäjäksi.
• Kun sertifiointi ja integraatio on suoritettu, voit jakaa ratkaisun asiakkaillesi helposti.

• 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.

• 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.

• Siirry kohtaan API-luettelo ja määritä ratkaisullesi sopivat APIt. 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.

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).

1. Voit nyt käyttää API-avaimen ja salaisen avaimen testiversioita ja alkaa suorittaa tapahtumia. Nouda ne Hankkeen yleiskatsaus -sivun Testiavain-välilehdeltä.

1. 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.
2. 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.

1. 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.
2. Toteuta puhelut näihin päätepisteisiin esimerkkipyynnöissä kuvatulla tavalla ja konfiguroi ne käyttämään testitunnistetietoja.
3. Vahvista, että vastaanotetut API-kutsuvastaukset ovat yhteensopivia asiakirjoissa näytettyjen vastausten kanssa.
4. Testaa toteutuksesi läpikotaisin FedEx-testiympäristössä testitunnistetietoja ja FedEx-testi-URL-osoitetta käyttäen.
5. Kun olet testannut ratkaisusi, sertifioi ne Salesforcessa. FedEx tarkistaa kaikki lähetetyt tiedot ja kertoo, kun sertifiointi on hyväksytty.

• FedEx siirtää sitten hankkeen/hankkeet tuotantoon.
• Tämän jälkeen näet Production API Keyn Hankkeen yleiskatsaus -sivun Production Key -välilehdellä.

• Tuotannon salainen avain on luotava napsauttamalla Salainen avain ‑kohdan Luo salainen avain ‑linkkiä.
• Voit nyt testata toimeenpanon uudelleen tuotantoympäristössä näytetietoja käyttäen.
• Käytä uuden integraation hyödyt hyväksesi!