Log ind

nShift Help Center

Kom godt i gang med DeliveryCheckout API

Avatar
Malene Tidemann
Opdateret

Delivery-checkout-label.png


DeliveryCheckout API er en integrationstjeneste til kommunikation mellem Delivery Checkout og din webshop.

 

Afsnit i denne artikel:

Introduktion

DeliveryCheckout API bruger et REST API-framework til kommunikation med JSON som databærer og tilbyder en række funktioner.

Med DeliveryCheckout API kan du:

  • Præsentere leveringsmuligheder i din webshop.
  • Klargøre forsendelser.
  • Uploade agentlister.

REST API-endepunkterne er kun tilgængelige via HTTPS og findes på api.unifaun.com.

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

 

Før du går i gang, skal du kende dit developer ID og oprette en API-nøgle.

Som forhandler kan du have outsourcet din logistik til en tredjepartslogistikudbyder (3PL). Du har brug for en konto, hvor du konfigurerer checkouten, og 3PL'en har brug for en konto til at udskrive forsendelserne. Den anbefalede proces i Delivery Checkout er at sende svaret fra POST /delivery-checkouts/{deliveryCheckoutId} til din 3PL. Derved oprettes forsendelsen fra 3PL'ens nShift Delivery-konto.

Alternativt kan 3PL'en hente oplysninger om den klargjorte forsendelse ved hjælp af GET /prepared-shipments/{prepareId}.

Vi anbefaler, at du forbereder en fallback-løsning til hver checkout-session, hvis du ikke får svar fra vores API, f.eks. på grund af vedligeholdelse. På den måde sikrer du, at dine kunder altid præsenteres for leveringsmuligheder.



 

Delivery Checkout-flow

checkout-flows.png

 

 

API-nøgler

En API-nøgle er en unik identifikator, der bruges til at autentificere en applikation eller bruger. API-nøgler kan bruges på konto- eller profilniveau.

Hvis profiladministration er aktiveret på din konto, kan du oprette API-nøgler, der er knyttet til en bestemt profil. Denne API-nøgle bruger derefter profilgruppen for den valgte profil til at filtrere, hvilke oplysninger du kan hente via API'et, og hvor de bliver sendt hen.


 

Opret en API-nøgle

  1. Log ind på nShift Delivery.
     
  2. Gå til Maintenance > API keys.

    API-keys.png
     
  3. Klik på New API key.
     
  4. Status skal være "Enabled".
     
  5. Type skal være sat til "Web Services (REST)".
     
  6. Angiv, hvad API-nøglen bruges til, i feltet Note. Da du kan oprette flere API-nøgler, anbefales det at bruge feltet Note.
     
  7. Indtast Valid IP addresses, hvis API-nøglen kun skal bruges fra bestemte IP-adresser eller IP-adresseintervaller.
     
  8. Feltet Email bruges ikke på nuværende tidspunkt.
     
  9. Indtast dit Developer ID. Normalt er developer ID dit bruger-ID på kontoen. Men hvis du har eller er en ERP-leverandør, webshopudbyder eller anden tredjepart, som sender data til kontoen, er det bruger-ID'et for leverandørens konto.
     
  10. Vælg en Profile i rullemenuen, hvis API-nøglen skal være knyttet til en bestemt profil.
     
  11. Klik på Save. Systemet genererer automatisk nøglen, som består af et ID, et secret ID og et kombineret ID.
    Det er ID'et og secret ID'et, som du bruger til at autentificere dig over for REST API-frameworket.

    new-API-key.png

Brug søgefunktionen til at søge efter dine API-nøgler.

 

Relaterede artikler