Delivery Cloud API:n käytön aloittaminen – nShift Help Center

Etsitkö tapaa keskittää kaikki lähetysdatasi yhteen paikkaan, vaikka käyttäisit useita eri book- ja print-ratkaisuja? nShiftin Delivery Cloud API:n avulla voit integroida kaikki lähetyksesi nShift Portaliin. Tämä mahdollistaa lähetysten helpon hallinnan ja seurannan sekä kattavan raportoinnin ja edistyneiden seurantatyökalujen käytön, mikä parantaa näkyvyyttä koko toimitusprosessissasi.

Tämän artikkelin sisältö:

Tärkeimmät käyttötapaukset
Delivery Cloud-organisaation luominen
Client ID:n ja salaisen avaimen luominen
Tokenin pyytäminen
Delivery Cloud API:n käyttö

Tärkeimmät käyttötapaukset

Asiakkaillamme on monia erilaisia kokoonpanoja ja ratkaisuja, mikä luo erilaisia käyttötapauksia Delivery Cloud API:lle. Tässä muutamia esimerkkejä tärkeimmistä käyttötapauksista:

Käyttötapaus 1: Useita lähetysvirtoja

Asiakas saattaa käyttää nShiftin book- ja print-ratkaisua yhdessä nShift Trackin kanssa, mutta lisäksi hänellä voi olla dropshipping-virta, joka käyttää toista book- ja print-ratkaisua. Delivery Cloud API:n avulla asiakas voi lähettää dropshipping-virran lähetykset nShift Portaliin ja käyttää Trackia kaikille lähetyksille.

Käyttötapaus 2: Emissions Tracker

Asiakas haluaa käyttää nShift Emissions Trackeria, mutta kaikkia lähetyksiä ei luoda nShiftin book- ja print-tuotteella. Delivery Cloud API:n avulla kaikki lähetykset voidaan lähettää järjestelmään ja niille voidaan saada päästölaskelmat.

Käyttötapaus 3: Ei-nShift book- ja print-ratkaisun käyttö

Asiakas käyttää muuta kuin nShiftin book- ja print-ratkaisua, mutta haluaa hankkia nShift Trackin. Delivery Cloud API:n avulla kaikki toisessa järjestelmässä varatut lähetykset voidaan lähettää järjestelmään ja hyödyntää nShift Trackin etuja.

Delivery Cloud-organisaation luominen

Aloita luomalla Organization ja Member Account Name nShift Portalissa. Tämä on sijainti, johon lähetykset luodaan. Huomaa, että sinun on luotava Organization Unit ja Member account erityisesti Delivery Cloudia varten, vaikka sinulla olisi jo olemassa oleva jäsenkäyttäjätili nShift Portalissa.

Kirjaudu sisään nShift Portaliin ja napsauta vasemmasta yläkulmasta Settings.
Valitse Company Management > Delivery Cloud Configuration. (Jos et näe tätä vaihtoehtoa, sinun tulee ottaa yhteyttä nShift Customer Serviceen saadaksesi sen käyttöön).
Napsauta Create ja sen jälkeen Add Organization Unit.
Syötä Organization Unit Name ja Member Account Name.
Napsauta Save.
Muista kopioida ja tallentaa Organization ID ja Member Account ID, sillä näitä arvoja tarvitaan API-pyyntöjä varten. Jos valitset Copy ID, arvo kopioidaan leikepöydälle.

Client ID:n ja salaisen avaimen luominen

Delivery Cloud API vaatii tokenien (Client ID ja Client Secret) käyttöä.

Aloita luomalla Client ID ja salainen avain, joita tarvitaan autentikointiin.

Kirjaudu sisään nShift Portaliin. (Jos et käytä Owner account -tiliä, sinun on ehkä pyydettävä käyttöoikeus Owner/Admin-käyttäjältä).
Napsauta oikeasta yläkulmasta Settings.
Valitse vasemmanpuoleisesta valikosta API Configuration > Clients.
Napsauta Clients-sivulla Add-painiketta.
Täytä kentät Display name ja Description. Valitse nimi ja kuvaus, joiden avulla token on helppo tunnistaa myöhemmin. Valitse Enable-valintaruutu aktivoidaksesi tokenin heti. (Voit aktivoida tai poistaa tokenin käytöstä milloin tahansa sen luomisen jälkeen).
Valitse Portal Shipment Data API kohdassa Allowed Scopes , eli API:t, joihin tarvitset käyttöoikeuden.
Napsauta Save. Client ID ja Client Secret luodaan nyt ja näytetään ruudulla. Tärkeää: Client Secret ei ole enää saatavilla sen jälkeen, kun suljet ponnahdusikkunan, joten varmista, että kopioit sen talteen.
Napsauta Close. Client ID näkyy nyt Clients-sivulla. Voit milloin tahansa napsauttaa Client ID:tä muokataksesi, poistaaksesi tai aktivoidaksesi/deaktivoidaksesi sen.

Tokenin pyytäminen

Delivery Cloud API käyttää OAuth 2.0 -todennusta. Käytä Client ID- ja Client Secret -tietojasi käyttötokenin luomiseen. Tämä tehdään lähettämällä POST-pyyntö seuraavaan päätepisteeseen:

Tuotanto: https://account.nshiftportal.com/idp/connect/token
Testi: https://account.qa.nshiftportal.dev/idp/connect/token

Aseta Content-Type-otsakkeen arvoksi application/x-www-form-urlencoded ja lähetä seuraavat arvot pyynnön rungossa:

grant_type: client_credentials
client_id: asiakastunnuksesi
client_secret: asiakkaan salainen avain

Jos pyyntö on kelvollinen ja asiakasohjelma on määritetty oikein, saat JSON-vastauksen:

{
    "access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsdfgvoiltgjvp...",
    "expires_in": 3600,
    "token_type": "Bearer"
}

Käyttötokenin käyttäminen

Kaikkien pyyntöjen on sisällettävä token Authorization-otsakkeessa. Lähetä palautettu access_token jokaisen pyynnön Authorization-otsakkeessa: Authorization: Bearer {access_token}.

Bearer-token on voimassa yhden tunnin. Pyydä uusi token, kun nykyisen tokenin voimassaolo päättyy.

Delivery Cloud API:n käyttö

Kun autentikointi on onnistunut, voit aloittaa Delivery Cloud API:n käytön. Aloita hakemalla listan kaikista kuljetusliikkeistä. Tunnista käytettävä kuljetusliike ja hae sen palvelut ja lisäpalvelut. Kun sinulla on oikeat kuljetusliikkeen, palvelun ja lisäpalvelujen ID:t, voit luoda lähetyksen.

Yhteenveto menetelmistä ja vaiheista, joita tarvitaan lähetysten lisäämiseen nShift Portaliin:

Hae lista kaikista kuljetusliikkeistä ja tunnista tarvitsemasi kuljetusliikkeen ID.
```
GET /metadata/carriers
```
Huom: tässä pyynnössä käytetty organizationId on ID, jonka kopioit ja tallensit Organization Unitin luomisen jälkeen.
Hae yhteenveto kuljetusliikkeen palveluista. Käytä kuljetusliikkeen ID:tä, jonka sait kuljetusliikelistasta.
```
GET /metadata/carriers/{carrierId}/services
```
Hae yhteenveto kuljetusliikkeelle saatavilla olevista lisäpalveluista. Käytä kuljetusliikkeen ID:tä, jonka sait kuljetusliikelistasta. Lisäpalveluja ei aina käytetä, joten tämä vaihe on valinnainen, jos lähetyksissäsi ei ole lisäpalveluja.
```
GET /metadata/carriers/{carrierId}/addons
```
Luo lähetykset käyttäen kuljetusliikkeen ID:tä, palvelun ID:tä ja addon-ID:tä.
```
PUT /shipments
```
Huom: tässä pyynnössä käytetty accountId on Member Account UUID, jonka kopioit ja tallensit Organization Unitin ja Member Accountin luomisen jälkeen. Muista käyttää Member Account ID:tä eikä Organization ID:tä.

Siirry tekniseen API-dokumentaatioon