nShift Checkout on rakennettu uuden API:n päälle. Siirtyminen DeliveryCheckoutista edellyttää tämän uuden API:n käyttöönottoa. Tämä artikkeli tarjoaa yleiskatsauksen kahden API:n tärkeimpiin eroihin, jotta voit suunnitella ja rajata integraatiotyösi.
Yhteenveto
| Alue | DeliveryCheckout (v1) | nShift Checkout (v2) |
|---|---|---|
| Asiakas kirjautuu | nShift Deliveryyn | nShift Portaliin |
| API:n perus-URL | https://api.unifaun.com/rs-extapi/v1 | https://api.nshiftportal.com/checkout |
| Todennusmalli | API-avain / bearer token | OAuth 2.0 -token (Client ID + Secret) |
| API-dokumentaatio | nShift API Connect | developers.nshiftone.com |
Todennus
nShift Checkout käyttää modernia OAuth 2.0 -todennusmallia. API-avaimen sijaan käytät nShift Portal -tililläsi luotua Client ID:tä ja Client Secretia käyttöoikeustokenin luomiseen.
- Token-endpoint: https://account.nshiftportal.com/idp/connect/token
- Tokenit ovat voimassa 1 tunnin.
- Suositus: ota käyttöön eksponentiaalinen backoff, jotta jos token-pyyntö epäonnistuu, uudelleenyritykset tehdään asteittain pidemmillä aikaväleillä.
Endpointien yleiskatsaus
Seuraava taulukko tiivistää tärkeimmät endpoint-muutokset ja niiden syyt.
| Toiminto | DeliveryCheckout (v1) | nShift Checkout (v2) | Muutoksen syy |
|---|---|---|---|
| Todennus | N/A | POST /idp/connect/token |
Turvallisempi ja standardoitu OAuth 2.0 -todennus. |
| Luo sessio | N/A | POST /v1/sessions/{checkoutConnectionId} |
Sessiot yhdistävät kuluttajan vuorovaikutukset mahdollistaen konversioseurannan ja A/B-testauksen (Experiments). |
| Hae toimitustavat | GET /delivery-checkouts |
POST /v1/shipping-options/{sessionId} |
Rakenteellinen POST-body mahdollistaa monipuolisemman syötteen, paremman tietosuojan ja tulevat laajennukset ilman rikkovia muutoksia. |
| Luo osittainen lähetys | POST /delivery-checkouts |
POST /shipments/v1/shipments |
Yhtenäinen lähetyksenluonti-endpoint, jota käytetään eri nShift API:eissa; selkeä vastuunjako. |
Keskeiset muutokset tarkemmin
Sessiot
nShift Checkout tuo käyttöön session käsitteen. Sessio yhdistää kuluttajan vuorovaikutukset checkout-prosessin aikana mahdollistaen yhtenäiset kokemukset ja tarkan konversioseurannan. Sessiot ovat myös Experiments-toiminnon (A/B-testauksen) perusta.
- Sessiot luodaan komennolla:
POST /v1/sessions/{checkoutConnectionId} - Sessio on voimassa 4 tuntia ja päivittyy jokaisen vuorovaikutuksen yhteydessä.
- Body on pakollinen (voi olla tyhjä); body-arvoja käytetään viitattaessa Groupiin tai Experimentiin, jossa on Segmentation.
Toimitustapojen hakeminen
Toimitustapojen hakupyyntö on muuttunut GET-pyynnöstä query-parametreilla rakenteelliseksi POST-pyynnöksi JSON-bodylla. Tämä parantaa tietosuojaa, mahdollistaa monipuolisemman syötteen ja helpottaa virheenkorjausta sekä ylläpitoa.
Esimerkki: Delivery Checkout v1
GET https://api.unifaun.com/delivery-checkouts/123456 ?currency=SEK&language=sv&tocountry=SE&tozipcode=41756&weight=2.3&cartprice=499
Esimerkki: nShift Checkout v2
POST /v1/shipping-options/{sessionId}
{
"currencyCode": "SEK",
"languageCode": "sv",
"totalWeightKg": 2.3,
"receiver": {
"postalCode": "41756",
"country": "SE"
},
"packages": [{ "weightKg": 2.3, "volumeCm3": null }],
"variables": { "cartPrice": 499 }
}
Response: tärkeimmät kenttänimien muutokset
Tutut rakennuspalikat ovat edelleen mukana responsessa, esimerkiksi vaihtoehtojen ID:t, carrier service -ID:t, noutopisteet ja lisäpalvelut, mutta joitakin parametreja on nimetty uudelleen tai rakennettu uudelleen.
Muutamia esimerkkejä alla:
| Käsite | Delivery Checkout (v1) | nShift Checkout (v2) |
|---|---|---|
| Vaihtoehdon tunniste | id |
optionId |
| Hinta |
priceValue / priceDescription
|
price / priceDescription
|
| Noutopisteet | agents[] |
pickupPoints[] |
Osittaisen lähetyksen luominen
Kun tilaus on konvertoitu, sinun täytyy luoda osittainen lähetys käyttämällä komentoa POST /shipments/v1/shipments. Tämä vaihe on pakollinen ja varmistaa täyden yhteensopivuuden kaikkien nykyisten ja tulevien nShift Checkout -ominaisuuksien kanssa, mukaan lukien tarkka konversioasteen laskenta Experiments-toiminnolle.
Huom:
Jos et halua käyttää osittaista lähetystä varsinaisen lähetyksen luomiseen shipping-ratkaisussasi, voit lisätä query-parametrin send-to-book-and-print=false URL-osoitteeseen /shipments. Tämä rekisteröi kutsun konversioseurantaa varten ilman osittaisen lähetyksen luomista shipping-ratkaisussa.
Lisää siinä tapauksessa myös extended-result=true, jotta saat laajennetun responsen Checkoutilta.
Varaaminen ja tulostaminen shipping-ratkaisusta
Lopullisen lähetyksen luominen (varaaminen ja etikettien tulostus) osittaisesta lähetyksestä tapahtuu edelleen nShift shipping-ratkaisussasi, eikä tämä osa integraatiota muutu.
- Delivery: Prepared shipments
- Ship: Completing a partial shipment from nShift Checkout
- Transsmart: Create, update and book prepared shipments
Täydellinen API-dokumentaatio
Saatavilla osoitteessa: https://developers.nshiftone.com/checkout/getting-started