nShift Checkout API on integraatiopalvelu nShift Checkoutin ja verkkokauppasi väliseen viestintään. nShift Checkout API käyttää REST API -kehystä kommunikointiin, jossa JSON toimii tiedonsiirtomuotona, ja tarjoaa useita toimintoja.
Aloittaaksesi API:n käytön sinun tulee käydä läpi alla olevat vaiheet, tai voit siirtyä suoraan tekniseen dokumentaatioon tästä.
- Luo Client ID ja secret
- Pyydä token
- Luo sessio
- Kutsu toimitustapa-endpointia
- Luo osittainen lähetys
- API-dokumentaatio
1. Luo Client ID ja secret
Aloita luomalla Client ID ja secret, joita tarvitaan autentikointiin.
- Kirjaudu sisään nShift Portaliin owner-käyttäjälläsi.
- Klikkaa vasemmasta yläkulmasta Settings ja siirry kohtaan API Configuration > Client.
- Klikkaa Clients-sivulla Add-painiketta.
- Täytä Display name ja Description. Valitse nimi ja kuvaus, joiden avulla token on helpompi tunnistaa myöhemmin. Valitse Enable-valintaruutu aktivoidaksesi tokenin heti. (Voit aktivoida tai poistaa tokenin käytöstä milloin tahansa sen luomisen jälkeen).
- Valitse Public checkout API kohdasta Allowed Scopes, jotka ovat API:t, joihin tarvitset pääsyn.
- Klikkaa Save. Client ID ja Client Secret luodaan ja näytetään näytöllä. Tärkeää: Client Secret ei ole enää saatavilla, kun suljet ponnahdusikkunan, joten varmista että kopioit sen talteen.
- Klikkaa Close. Client ID näkyy nyt Clients-sivulla. Voit milloin tahansa klikata Client ID:tä muokataksesi tai poistaaksesi sen tai aktivoidaksesi/deaktivoidaksesi sen.
2. Pyydä token
Käytä Client ID:täsi ja Client Secretiäsi käyttöoikeustokenin luomiseen. Tämä tehdään lähettämällä POST-pyyntö seuraavaan endpointiin:
https://account.nshiftportal.com/idp/connect/token
Esimerkki:
POST https://account.nshiftportal.com/idp/connect/token
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded
client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials
Jos pyyntö on kelvollinen ja client on määritetty oikein, saat takaisin JSON-responsen:
{
"access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsoidfgvoiltgjvpdrofjmwpkldujrftvoifgkhbnilsakjprotglijkqp2owrlfjkvmowrifgho2qw9ouejifpe9rodtuj3-0porfij9odtujgw0etioyh",
"expires_in": 3600,
"token_type": "Bearer"
}Bearer-token on voimassa yhden tunnin.
3. Luo sessio
Käytä bearer-tokenia kutsuaksesi nShift Checkoutin session-endpointia. Lähetä POST-pyyntö osoitteeseen:
https://www.nshiftportal.com/checkout/options/v1/sessions/{checkoutConnectionId}
Käytä Connection ID:tä path-parametrina. Siirry ylävalikosta kohtaan Connections ja etsi Connection ID listalta. (Lue lisää Connections-toiminnosta tästä).
POST-kutsu luo session, joka on voimassa 4 tuntia, ellei sitä käytetä tämän ajan sisällä. Sessio sisältää tietoja checkout-konfiguraatiostasi, esimerkiksi lähettäjän tiedot. Jos haluat vaihtaa, mitä Checkout-konfiguraatiota käytetään toimitustapojen hakemiseen, voit yksinkertaisesti vaihtaa, mihin konfiguraatioon connection ID viittaa.
Vaihtaaksesi, mihin Checkout-konfiguraatioon connection ID viittaa, siirry kohtaan Connections ylävalikossa ja klikkaa connectionia, jota haluat muuttaa. Valitse toinen Checkout pudotusvalikosta Configuration ja klikkaa Save.
4. Kutsu toimitustapa-endpointia
Session ID:tä käyttämällä voit tehdä POST-kutsun toimitustapa-endpointiin:
https://www.nshiftportal.com/checkout/options/v1/shipping-options/{sessionId}
Toimitustapa-endpointin request body sisältää tietoja vastaanottajasta, paketista/paketeista ja muista lisätiedoista, jotka voivat vaikuttaa saatavilla oleviin toimitustapoihin. Response sisältää listan saatavilla olevista toimitustavoista. Jos käytät nShift Checkout -widgettiä, nämä tiedot tulee välittää oikealle metodille toimitustapojen näyttämiseksi.
5. Luo osittainen lähetys
Kun loppuasiakkaasi on valinnut toimitustavan, voit luoda osittaisen lähetyksen Book and Print -alustallasi (nShift Delivery, nShift Ship tai nShift Transsmart).
Tee POST-kutsu osoitteeseen:
https://www.nshiftportal.com/checkout/shipments/v1/shipments
Lisätietoja löytyy API-dokumentaatiosta.
Tämän kutsun request body sisältää session ID:n, valitun toimitustavan ID:n ja muita lähetykseen liittyviä tietoja, kuten order ID:n, joka toimii yksilöllisenä tunnisteena osittaisen lähetyksen löytämiseksi Book and Print -alustalta. Request body sisältää myös vastaanottajan tiedot. Voit muuttaa joitakin vastaanottajan tietoja (joitakin arvoja, kuten postinumeroa, ei voi muuttaa niiden vaikutuksen vuoksi saatavilla oleviin toimitustapoihin).
Kutsu luo osittaisen lähetyksen Book and Print -alustalle valittua toimitustapaa varten. Muuttaaksesi osittaisen lähetyksen varsinaiseksi lähetykseksi sinun tulee kutsua siihen liittyviä endpointteja vastaavissa Book and Print -alustoissa.
API-dokumentaatio
Tekninen API-dokumentaatiomme löytyy täältä: