Aanmelden

nShift Help Center

Aan de slag met DeliveryCheckout API

Avatar
Malene Tidemann
Bijgewerkt

Delivery-checkout-label.png


DeliveryCheckout API is een integratieservice voor communicatie tussen Delivery Checkout en uw webshop.

 

Onderdelen in dit artikel:

Introductie

DeliveryCheckout API gebruikt een REST API-framework voor communicatie met JSON als gegevensdrager en biedt een aantal functies.

Met DeliveryCheckout API kunt u:

  • Leveringsopties presenteren in uw webshop.
  • Zendingen voorbereiden.
  • Agentlijsten uploaden.

De REST API-eindpunten zijn uitsluitend toegankelijk via HTTPS en bevinden zich op api.unifaun.com.

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

 

Voordat u begint, moet u uw developer ID kennen en een API-sleutel aanmaken.

Als handelaar heeft u mogelijk uw logistiek uitbesteed aan een externe logistieke dienstverlener (3PL). U hebt een account nodig waarin u de checkout configureert, en de 3PL heeft een account nodig om de zendingen af te drukken. Het aanbevolen proces in Delivery Checkout is om de respons van POST /delivery-checkouts/{deliveryCheckoutId} naar uw 3PL te sturen. Hierdoor wordt de zending aangemaakt vanuit het nShift Delivery-account van de 3PL.

Als alternatief kan de 3PL de informatie over de voorbereide zending ophalen via GET /prepared-shipments/{prepareId}.

Wij raden aan om voor elke checkoutsessie een fallback-oplossing voor te bereiden voor het geval u geen reactie van onze API ontvangt, bijvoorbeeld wegens onderhoud. Zo zorgt u ervoor dat uw klanten altijd verzendopties te zien krijgen.



 

Delivery Checkout-flow

checkout-flows.png

 

 

API-sleutels

Een API-sleutel is een unieke identificatie die wordt gebruikt om een applicatie of gebruiker te authenticeren. API-sleutels kunnen op account- of profielniveau worden gebruikt.

Als profielbeheer op uw account is geactiveerd, kunt u API-sleutels aanmaken die aan een specifiek profiel zijn gekoppeld. Deze API-sleutel gebruikt vervolgens de profielgroep van het geselecteerde profiel om te bepalen welke informatie u via de API kunt ophalen en waar deze wordt geplaatst.


 

Een API-sleutel aanmaken

  1. Log in op nShift Delivery.
     
  2. Ga naar Maintenance > API keys.

    API-keys.png
     
  3. Klik op New API key.
     
  4. Status moet zijn ingesteld op "Enabled".
     
  5. Type moet zijn ingesteld op "Web Services (REST)".
     
  6. Geef in het veld Note aan waarvoor de API-sleutel wordt gebruikt. Omdat u meerdere API-sleutels kunt aanmaken, wordt het gebruik van het veld Note aanbevolen.
     
  7. Voer Valid IP addresses in als de API-sleutel alleen vanaf bepaalde IP-adressen of IP-adresbereiken mag worden gebruikt.
     
  8. Het veld Email wordt momenteel niet gebruikt.
     
  9. Voer uw Developer ID in. Normaal gesproken is het developer ID uw gebruikers-ID van het account. Maar als u een ERP-leverancier, webshopprovider of andere derde partij bent of gebruikt die gegevens naar het account stuurt, is dit het gebruikers-ID van het account van die leverancier.
     
  10. Selecteer een Profile in de vervolgkeuzelijst als de API-sleutel aan een specifiek profiel moet worden gekoppeld.
     
  11. Klik op Save. Het systeem genereert automatisch de sleutel, bestaande uit een ID, een secret ID en een gecombineerd ID.
    Het zijn het ID en het secret ID die u gebruikt voor authenticatie binnen het REST API-framework.

    new-API-key.png

Gebruik de zoekfunctie om uw API-sleutels te zoeken.

 

Verwante artikelen