DeliveryCheckout API on integraatiopalvelu Delivery Checkoutin ja verkkokauppasi väliseen viestintään.

 

Tämän artikkelin osiot:

• Johdanto
• Delivery Checkout -prosessi
• Developer ID
• API-avaimet
   

Johdanto

DeliveryCheckout API käyttää REST API -kehystä viestintään JSON-muotoisen tiedonsiirron avulla ja tarjoaa useita toimintoja.

DeliveryCheckout API:n avulla voit:

• Näyttää toimitustapoja verkkokaupassasi.
• Valmistella lähetyksiä.
• Ladata noutopistelistoja.

REST API -rajapinnan päätepisteet ovat käytettävissä vain HTTPS:n kautta ja ne sijaitsevat osoitteessa api.unifaun.com.

https://api.unifaun.com/rs-extapi/v1

Ennen aloittamista sinun tulee tietää Developer ID ja luoda API-avain.

Kauppiaana olet saattanut ulkoistaa logistiikkasi kolmannen osapuolen logistiikkapalveluntarjoajalle (3PL). Tarvitset tilin, jolla määrität checkoutin, ja 3PL tarvitsee tilin lähetysten tulostamiseen. Suositeltu prosessi Delivery Checkoutissa on lähettää POST /delivery-checkouts/{deliveryCheckoutId} -kutsun vastaus 3PL:lle. Tällöin lähetys luodaan 3PL:n nShift Delivery -tililtä.

Vaihtoehtoisesti 3PL voi hakea valmistellun lähetyksen tiedot GET /prepared-shipments/{prepareId} -kutsulla.

Suosittelemme valmistamaan vararatkaisun jokaiselle checkout-istunnolle siltä varalta, että API:mme ei vastaa esimerkiksi huoltotöiden vuoksi. Näin varmistat, että asiakkaillesi näytetään aina toimitusvaihtoehtoja.

Delivery Checkout -prosessi

API-avaimet

API-avain on yksilöllinen tunniste, jota käytetään sovelluksen tai käyttäjän tunnistamiseen. API-avaimia voidaan käyttää tili- tai profiilitasolla.

Jos profiilihallinta on aktivoitu tililläsi, voit luoda API-avaimia, jotka on liitetty tiettyyn profiiliin. Tällöin API-avain käyttää valitun profiilin profiiliryhmää suodattamaan, mitä tietoja voit hakea API:n avulla ja minne tiedot lähetetään.


 

API-avaimen luominen

1. Kirjaudu sisään nShift Deliveryyn.
    
2. Siirry kohtaan Maintenance > API keys.
   
   
    
3. Napsauta New API key.
    
4. Status-asetuksen tulee olla "Enabled".
    
5. Type-asetuksen tulee olla "Web Services (REST)".
    
6. Määritä kentässä Note, mihin API-avainta käytetään. Koska voit luoda useita API-avaimia, Note-kentän käyttöä suositellaan.
    
7. Syötä Valid IP addresses, jos API-avainta saa käyttää vain tietyistä IP-osoitteista tai IP-osoitealueilta.
    
8. Email-kenttää ei tällä hetkellä käytetä.
    
9. Anna Developer ID. Normaalisti developer ID on tilisi käyttäjätunnus. Jos kuitenkin käytät tai olet ERP-toimittaja, verkkokauppatoimittaja tai muu kolmas osapuoli, joka lähettää tietoja tilille, käytetään palveluntarjoajan tilin käyttäjätunnusta.
    
10. Valitse pudotusvalikosta Profile, jos API-avain tulee liittää tiettyyn profiiliin.
     
11. Napsauta Save. Järjestelmä luo automaattisesti avaimen, joka koostuu ID:stä, secret ID:stä ja yhdistetystä ID:stä.
    REST API -kehyksen tunnistautumisessa käytetään ID:tä ja secret ID:tä.
    
    

Käytä hakutoimintoa API-avainten etsimiseen.