Logga in

nShift Help Center

Kom igång med DeliveryCheckout API

Avatar
Malene Tidemann
Uppdaterad

Delivery-checkout-label.png


DeliveryCheckout API är en integrationstjänst för kommunikation mellan Delivery Checkout och din webbutik.

 

Avsnitt i denna artikel:

Introduktion

DeliveryCheckout API använder ett REST API-ramverk för kommunikation med JSON som databärare och erbjuder ett antal funktioner.

Med DeliveryCheckout API kan du:

  • Presentera leveransalternativ i din webbutik.
  • Förbereda försändelser.
  • Ladda upp ombudslistor.

REST API-slutpunkterna är endast tillgängliga via HTTPS och finns på api.unifaun.com.

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

 

Innan du börjar behöver du känna till ditt Developer ID och skapa en API-nyckel.

Som handlare kan du ha outsourcat din logistik till en tredjepartslogistikleverantör (3PL). Du behöver ett konto där du konfigurerar checkouten, och 3PL behöver ett konto för att skriva ut försändelserna. Den rekommenderade processen i Delivery Checkout är att skicka svaret från POST /delivery-checkouts/{deliveryCheckoutId} till din 3PL. Detta gör att försändelsen skapas från 3PL:ens nShift Delivery-konto.

Alternativt kan 3PL hämta information om den förberedda försändelsen med hjälp av GET /prepared-shipments/{prepareId}.

Vi rekommenderar att du förbereder en reservlösning för varje checkout-session om du inte får svar från vårt API, till exempel på grund av underhåll. På så sätt säkerställer du att dina kunder alltid får se leveransalternativ.



 

Delivery Checkout-flöde

checkout-flows.png

 

 

API-nycklar

En API-nyckel är en unik identifierare som används för att autentisera en applikation eller användare. API-nycklar kan användas på konto- eller profilnivå.

Om profilhantering är aktiverad på ditt konto kan du skapa API-nycklar som är kopplade till en specifik profil. API-nyckeln använder då profilgruppen för den valda profilen för att filtrera vilken information du kan hämta via API:et och vart den ska skickas.


 

Skapa en API-nyckel

  1. Logga in i nShift Delivery.
     
  2. Gå till Maintenance > API keys.

    API-keys.png
     
  3. Klicka på New API key.
     
  4. Status ska vara inställd på "Enabled".
     
  5. Type ska vara inställd på "Web Services (REST)".
     
  6. Ange vad API-nyckeln ska användas till i fältet Note. Eftersom du kan skapa flera API-nycklar rekommenderas att använda fältet Note.
     
  7. Ange Valid IP addresses om API-nyckeln endast ska få användas från specifika IP-adresser eller IP-adressintervall.
     
  8. Fältet Email används för närvarande inte.
     
  9. Ange ditt Developer ID. Normalt är Developer ID ditt användar-ID på kontot. Men om du är, eller använder, en ERP-leverantör, webbutiksleverantör eller annan tredje part som skickar data till kontot, är detta användar-ID:t för leverantörens konto.
     
  10. Välj en Profile i rullgardinsmenyn om API-nyckeln ska kopplas till en specifik profil.
     
  11. Klicka på Save. Systemet genererar automatiskt nyckeln som består av ett ID, ett secret ID och ett kombinerat ID.
    Det är ID:t och secret ID:t som används för autentisering mot REST API-ramverket.

    new-API-key.png

Använd sökfunktionen för att hitta dina API-nycklar.

 

Relaterade artiklar