FedEx API:t tukevat OAuth 2.0 (haltijan tunniste) -todennustapaa, jolla valtuutetaan sovelluksesi API-pyynnöt FedExin resursseihin. OAuth-käyttötunniste on luotava uudelleen 60 minuutin välein ja annettava jokaisen API-tapahtuman yhteydessä, jotta FedExin resursseihin pääsy todennetaan ja valtuutetaan.

Tämän APIn avulla voit valtuuttaa API-pyynnöt, ja se vaaditaan FedEx-resurssien todentamiseen. Seuraavassa osiossa kerrotaan APIn tärkeimmät ennakkoedellytykset:

Kun rekisteröidyt FedEx Developer Portaliin, FedEx toimittaa asiakastunnuksen (API-avaimen) ja asiakassalaisuuden (salaisen avaimen) yhdistelmän, joilla todennetaan projektisi API-pyynnöt. Jokaiseen organisaatiosi projektiin liittyy asiakastunnuksen ja asiakassalaisuuden yhdistelmä, jota kutsutaan API-pääsytiedoiksi.

Huomaa: Asiakkaat (sisäiset, yhteensopivat tai omistusoikeudelliset pää-/alikohteet) voivat pyytää FedExin edustajalta API-avaimet ja salaiset avaimet.

FedExin^® asiakkaat (sisäiset, yhteensopivat tai omistusoikeudelliset pää-/alikohteet) voivat saada lisäkerroksen turvallisuutta lähettämällä aliavaimen (asiakassalaisuuden) ja alisalaisuuden (asiakkaan salasanan) API-avaimen ja salaisen avaimen lisäksi OAuth-tunnisteen luomiseksi. Tätä tunnusta käytetään kaikkien API-pyyntöjen todennukseen.

Voit luoda uudestaan unohdetun salaisen avaimen FedEx Developer Portaln Projektit-sivulla.

Huomautus: Uusien avaimien luominen aiheuttaa koodimuutoksen sovelluksessasi.

Tämän asiakirjan tärkeät tiedot:

• Asiakasavain API-avaimena
• Asiakassalaisuus salaisena avaimena
• Aliavain asiakasavaimena
• Alisalaisuus asiakkaan salasanana

API-pääsytietoja käytetään seuraaviin tarkoituksiin:

• Ne tunnistavat API-kutsuja tekevän projektin.
• Ne valtuuttavat pääsyn projektissasi käyttöön otettuun APIin.

Tunnistetiedot luodaan perustuen FedEx Developer Portalissa annettuihin syötteisiin:

• Asiakastunnus – API-avain (asiakastunnus) luodaan, kun projekti luodaan FedEx Developer Portalissa. Voit myös tarkastella projektiin liitettyä API-avainta Hankkeen yleiskatsaus -sivulla.
• Asiakassalaisuus – Näet salaisen avaimen (asiakassalaisuuden) vahvistussivulla, kun projekti luodaan FedEx Developer Portalissa. Salainen avain voidaan tarvittaessa myös luoda uudestaan Hankkeen yleiskatsaus -sivulla.

Huomautus: FedExin^® asiakkaiden (sisäiset, yhteensopivat tai omistusoikeudelliset ali-/pääkohteet) pitää lähettää aliavain (asiakassalaisuus) ja alisalaisuus (asiakkaan salasana) API-avaimen ja salaisen avaimen lisäksi luodakseen OAuth-tunnisteen. Löydät pääsytietojen rekisteröinti -APIsta tiedot miten saada aliavain ja alisalaisuus.

API-valtuutus

Kun olet saanut API-pääsytiedot FedEx Developer Portalissa, OAuth-päätepisteen avulla hankitaan käyttötunniste, jota käytetään tunnistetietoina kussakin API-tapahtumassa.

Nämä ovat OAuth-pyynnön vaaditut syötteet:

• grant_type – Asiakkaan tyyppi. (Kelvolliset arvot: client_credentials, csp_credentials, client_pc_credentials)
• client_id – Viittaa projektin API-avaimeen.
• client_secret – Viittaa projektin APIn salaiseen avaimeen.

FedExin^® sisäisten ja yhteensopivien asiakkaiden sekä omistusoikeudellisten pää-/alikohdeasiakkaiden on lisäksi lähetettävä alla mainitut lisäsyötteet:

• child_id – Pääsytietojen rekisteröinti -API-pyynnön palauttama asiakasavain.
• child_secret – Pääsytietojen rekisteröinti -API-pyynnön palauttama asiakkaan salasana.

Tämän pyynnön pitäisi palauttaa tuloksena seuraavaa:

• access_token – Salattu OAuth-tunniste, jota on käytettävä API-tapahtumassa.
• token_type – Tunnisteen tyyppi. Tässä tapauksessa se on haltijan todennus.
• expires_in – Tunnisteen päättymisaika millisekunneissa. Yksi tunti on vakioaika tunnisteen päättymiselle.
• Scope – Kuluttajalle annetun valtuutuksen laajuus.

Esimerkkejä

Pyyntö:

POST /oauth/token HTTP/1.1
grant_type= client_credentials&client_id=asiakkaasi ID&client_secret=salaisuutesi

Vastaus:

{ ″access_token″: ″eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX……..″,
″token_type″: ″bearer″,
″expires_in″: 3600,
″scope″: ″CXS″
}

Pyyntö FedExin^® sisäisille tai yhteensopiville asiakkaille:

POST /oauth/token HTTP/1.1
grant_type= csp_credentials&client_id=asiakastunnus&client_secret=asiakassalaisuus&child_key=aliavain&child_secret=alisalaisuus

Vastaus:

{ ″access_token″: ″eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX……..″,
″token_type″: ″bearer″,
″expires_in″: 3600,
″scope″: ″CXS″
}

Pyyntö FedExin^® omistusoikeudellisille pää-/alikohdeasiakkaille:

POST /oauth/token HTTP/1.1
grant_type= client_pc_credentials&client_id=Client ID&client_secret= Client secret&child_key=Child key&child_secret=Child Secret

Vastaus:

{ ″access_token″: ″eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX……..″,
″token_type″: ″bearer″,
″expires_in″: 3600,
″scope″: ″CXS″
}

Huomaa: käyttötunniste vanhentuu tunnin kuluttua, mutta sen voi luoda uudelleen lähettämällä POST-pyynnön OAuth/token-päätepisteeseen.