Logg på

nShift Help Center

Komme i gang med DeliveryCheckout API

Avatar
Malene Tidemann
Oppdatert

Delivery-checkout-label.png


DeliveryCheckout API er en integrasjonstjeneste for kommunikasjon mellom Delivery Checkout og nettbutikken din.

 

Innhold i denne artikkelen:

Introduksjon

DeliveryCheckout API bruker et REST API-rammeverk for kommunikasjon med JSON som databærer og tilbyr en rekke funksjoner.

Med DeliveryCheckout API kan du:

  • Presentere leveringsalternativer i nettbutikken din.
  • Klargjøre sendinger.
  • Laste opp agentlister.

REST API-endepunktene er kun tilgjengelige via HTTPS og finnes på api.unifaun.com.

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

 

Før du kommer i gang må du kjenne din Developer ID og opprette en API-nøkkel.

Som forhandler kan du ha satt bort logistikken til en tredjeparts logistikkleverandør (3PL). Du trenger en konto hvor du konfigurerer checkouten, og 3PL trenger en konto for å skrive ut sendingene. Den anbefalte prosessen i Delivery Checkout er å sende svaret fra POST /delivery-checkouts/{deliveryCheckoutId} til 3PL-en din. Dette oppretter sendingen fra 3PL-ens nShift Delivery-konto.

Alternativt kan 3PL hente informasjon om den klargjorte sendingen ved hjelp av GET /prepared-shipments/{prepareId}.

Vi anbefaler at du forbereder en reserve-/fallback-løsning for hver checkout-økt dersom du ikke får svar fra API-et vårt, for eksempel på grunn av vedlikehold. På den måten sikrer du at kundene alltid får presentert leveringsalternativer.



 

Delivery Checkout-flyt

checkout-flows.png

 

 

API-nøkler

En API-nøkkel er en unik identifikator som brukes til å autentisere en applikasjon eller bruker. API-nøkler kan brukes på konto- eller profilnivå.

Hvis profiladministrasjon er aktivert på kontoen din, kan du opprette API-nøkler som er knyttet til en bestemt profil. Denne API-nøkkelen bruker da profilgruppen til den valgte profilen for å filtrere hvilken informasjon du kan hente via API-et og hvor den skal sendes.


 

Opprett en API-nøkkel

  1. Logg inn i nShift Delivery.
     
  2. Gå til Maintenance > API keys.

    API-keys.png
     
  3. Klikk på New API key.
     
  4. Status skal være satt til "Enabled".
     
  5. Type skal være satt til "Web Services (REST)".
     
  6. Beskriv hva API-nøkkelen skal brukes til i feltet Note. Siden du kan opprette flere API-nøkler, anbefales det å bruke feltet Note.
     
  7. Angi Valid IP addresses dersom API-nøkkelen kun skal kunne brukes fra bestemte IP-adresser eller IP-adresseområder.
     
  8. Feltet Email brukes ikke for øyeblikket.
     
  9. Oppgi din Developer ID. Vanligvis er Developer ID bruker-ID-en på kontoen. Men hvis du er, eller benytter, en ERP-leverandør, nettbutikkleverandør eller annen tredjepart som sender data til kontoen, er dette bruker-ID-en til leverandørens konto.
     
  10. Velg en Profile fra rullegardinlisten dersom API-nøkkelen skal knyttes til en bestemt profil.
     
  11. Klikk på Save. Systemet genererer automatisk nøkkelen, som består av en ID, en secret ID og en kombinert ID.
    Det er ID-en og secret ID-en som brukes til autentisering mot REST API-rammeverket.

    new-API-key.png

Bruk søkefunksjonen for å finne API-nøklene dine.

 

Relaterte artikler