Aanmelden
nShift Help Center

Aan de slag met Delivery Cloud API

Avatar
Malene Tidemann
Bijgewerkt

Wilt u al uw verzendgegevens centraliseren op één locatie, ook al werkt u met meerdere book- en print-producten? Met de Delivery Cloud API van nShift kunt u al uw zendingen integreren in nShift Portal. Hierdoor kunt u uw zendingen eenvoudig beheren en volgen, terwijl u profiteert van uitgebreide rapportages en geavanceerde trackingtools, wat zorgt voor betere zichtbaarheid binnen uw volledige verzendproces.

 

Inhoud van dit artikel:

 

Belangrijkste use cases

Onze klanten hebben veel verschillende configuraties en oplossingen, wat leidt tot uiteenlopende use cases voor de Delivery Cloud API. Hier volgen enkele voorbeelden van de belangrijkste use cases:

 

Use case 1: Meerdere verzendstromen

De klant gebruikt mogelijk een nShift book- en print-oplossing samen met nShift Track, maar heeft daarnaast ook een dropshippingstroom die gebruikmaakt van een andere book- en print-oplossing. Met de Delivery Cloud API kan de klant zendingen uit de dropshippingstroom naar nShift Portal sturen en Track gebruiken voor alle zendingen.

 

Use case 2: Emissions Tracker

De klant wil de nShift Emissions Tracker gebruiken, maar niet alle zendingen worden aangemaakt met een nShift book- en print-product. Met behulp van de Delivery Cloud API kunnen alle zendingen worden verzonden en emissieberekeningen worden verkregen.

 

Use case 3: Gebruik van een niet-nShift book- en print-oplossing

De klant gebruikt een niet-nShift book- en print-oplossing maar wil nShift Track aanschaffen. Met de Delivery Cloud API kunnen alle in een ander systeem geboekte zendingen worden verzonden en kan gebruik worden gemaakt van nShift Track.

 

 

Een Delivery Cloud-organisatie aanmaken

Begin met het aanmaken van een Organization en een Member Account Name in nShift Portal. Dit is de locatie waar de zendingen worden aangemaakt. Houd er rekening mee dat u een Organization Unit en een Member account specifiek voor Delivery Cloud moet aanmaken, zelfs als u al een bestaand member account in nShift Portal heeft.

  1. Log in op nShift Portal en klik linksboven op Settings.
     
  2. Kies Company Management > Delivery Cloud Configuration. (Als u deze optie niet ziet, moet u contact opnemen met nShift Customer Service om deze te laten activeren).


     
  3. Klik op Create en vervolgens op Add Organization Unit.


     
  4. Voer een Organization Unit Name en een Member Account Name in.


     
  5. Klik op Save.
     
  6. Vergeet niet uw Organization ID en Member Account ID te kopiëren en op te slaan, aangezien deze waarden nodig zijn voor de API-aanvragen. Door Copy ID te kiezen, wordt de waarde naar uw klembord gekopieerd.



 

Client ID en secret aanmaken

De Delivery Cloud API vereist het gebruik van tokens (Client IDs en Client Secrets).

Begin met het aanmaken van de Client ID en secret die nodig zijn voor authenticatie.

  1. Log in op nShift Portal. (Als u geen Owner account gebruikt, moet u mogelijk toegang aanvragen bij de Owner/Admin).
     
  2. Klik rechtsboven op Settings.

    nav-settings.png
     
  3. Kies API Configuration > Clients in het menu aan de linkerkant.
     
  4. Klik op de pagina Clients op de knop Add.
     
  5. Vul Display name en Description in. Kies een naam en beschrijving waarmee u het token later eenvoudig kunt identificeren. Vink het vakje Enable aan om het token direct te activeren. (U kunt het token op elk moment na aanmaak activeren of deactiveren).

    Delivery Cloud-client.png
     
  6. Kies Portal Shipment Data API onder Allowed Scopes ; dit zijn de API’s waarvoor u toegang nodig heeft. 
     
  7. Klik op Save. Uw Client ID en Client Secret worden nu gegenereerd en op het scherm weergegeven. Belangrijk: De Client Secret is niet meer beschikbaar nadat u de popup sluit, dus zorg ervoor dat u deze kopieert.
     
  8. Klik op Close. De Client ID wordt nu weergegeven op de pagina Clients. U kunt op elk moment op een Client ID klikken om deze te bewerken, verwijderen of in/uit te schakelen.

 

 

Een token aanvragen

De Delivery Cloud API maakt gebruik van OAuth 2.0. Gebruik uw Client ID en Client Secret om een toegangstoken te genereren. Dit doet u door een POST-verzoek naar het volgende endpoint te sturen:
 

  • Productie: https://account.nshiftportal.com/idp/connect/token
  • Test: https://account.qa.nshiftportal.dev/idp/connect/token


Stel de header Content-Type in op application/x-www-form-urlencoded en stuur de volgende waarden mee in de body van het verzoek:

  • grant_type: client_credentials
  • client_id: uw client-ID
  • client_secret: uw clientgeheim

 

Als het verzoek geldig is en de client correct is geconfigureerd, ontvangt u een JSON-respons:

{
    "access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsdfgvoiltgjvp...",
    "expires_in": 3600,
    "token_type": "Bearer"
}

 

Het toegangstoken gebruiken

Alle verzoeken moeten het token bevatten in de Authorization-header. Stuur het ontvangen access_token mee in de Authorization-header van elk verzoek: Authorization: Bearer {access_token}.

 

Het bearer-token is één uur geldig. Vraag een nieuw token aan wanneer het huidige token verloopt.

 

De Delivery Cloud API gebruiken

Zodra u bent geauthenticeerd, kunt u beginnen met het gebruik van de Delivery Cloud API. Begin met het ophalen van de lijst met alle vervoerders. Identificeer de vervoerder die u wilt gebruiken en haal vervolgens de diensten en addons voor die vervoerder op. Zodra u de juiste ID’s voor vervoerder, dienst en addons heeft, kunt u de zending aanmaken.

 

Overzicht van de methoden en stappen die nodig zijn om uw zendingen toe te voegen aan nShift Portal:

  1. Haal een lijst op van alle vervoerders en identificeer de ID van de vervoerder die u nodig heeft.

    GET /metadata/carriers

    Opmerking: de organizationId die in deze aanvraag wordt gebruikt, is de ID die u hebt gekopieerd en opgeslagen na het aanmaken van de Organization Unit. 
     

  2. Haal een overzicht op van de diensten van een vervoerder. Gebruik de vervoerder-ID die u hebt verkregen uit de lijst met vervoerders.

    GET /metadata/carriers/{carrierId}/services

     

  3. Haal een overzicht op van addons die beschikbaar zijn voor een vervoerder. Gebruik de vervoerder-ID die u hebt verkregen uit de lijst met vervoerders. Addons worden niet altijd gebruikt, dus deze stap is optioneel als uw zendingen geen addons bevatten.

    GET /metadata/carriers/{carrierId}/addons

     

  4. Maak zendingen aan met behulp van de vervoerder-ID, dienst-ID en addon-ID.

    PUT /shipments

    Opmerking: de accountId die in deze aanvraag wordt gebruikt, is de Member Account UUID die u hebt gekopieerd en opgeslagen na het aanmaken van de Organization Unit en Member Account. Vergeet niet de Member Account ID te gebruiken en niet de Organization ID. 
     

Ga naar de technische API-documentatie

Verwante artikelen