Logga in

nShift Help Center

Komma igång med DeliveryCloud API

Avatar
Malene Tidemann
Uppdaterad

Letar du efter ett sätt att samla all din försändelsedata på ett centralt ställe, även om du arbetar med flera olika book- och print-produkter? Med DeliveryCloud API från nShift kan du integrera alla dina försändelser i nShift Portal. Detta gör det enkelt att hantera och spåra dina försändelser samtidigt som du får tillgång till omfattande rapportering och avancerade spårningsverktyg, vilket ger bättre insyn genom hela din leveransprocess.

 

Innehåll i denna artikel:

 

Viktigaste användningsområden

Våra kunder har många olika uppsättningar och lösningar, vilket skapar olika användningsområden för DeliveryCloud API. Här är några exempel på de viktigaste användningsområdena:

 

Användningsområde 1: Flera försändelseflöden

Kunden kan använda en nShift book- och print-lösning tillsammans med nShift Track, men har även ett dropshippingflöde som använder en annan book- och print-lösning. Med DeliveryCloud API kan kunden skicka försändelser från dropshippingflödet till nShift Portal och använda Track för alla försändelser.

 

Användningsområde 2: Emissions Tracker

Kunden vill använda nShift Emissions Tracker, men alla försändelser skapas inte med hjälp av en nShift book- och print-produkt. Med hjälp av DeliveryCloud API kan de skicka in alla försändelser och få utsläppsberäkningar.

 

Användningsområde 3: Användning av en icke-nShift book- och print-lösning

Kunden använder en icke-nShift book- och print-lösning men vill köpa nShift Track. Med hjälp av DeliveryCloud API kan de skicka alla försändelser som bokats i ett annat system och dra nytta av nShift Track.

 

 

Skapa en DeliveryCloud-organisation

Börja med att skapa en Organization och ett Member Account Name i nShift Portal. Detta är platsen där försändelserna kommer att skapas. Observera att du måste skapa en Organization Unit och ett Member account specifikt för DeliveryCloud, även om du redan har ett befintligt medlemskonto i nShift Portal.

  1. Logga in på nShift Portal och klicka på Settings längst upp till vänster.
     
  2. Välj Company Management > Delivery Cloud Configuration. (Om du inte ser detta alternativ måste du kontakta nShift Customer Service för att få det aktiverat).


     
  3. Klicka på Create och därefter på Add Organization Unit.


     
  4. Ange ett Organization Unit Name och ett Member Account Name.


     
  5. Klicka på Save.
     
  6. Kom ihåg att kopiera och spara ditt Organization ID och Member Account ID, eftersom dessa värden behövs för API-förfrågningarna. Om du väljer Copy ID kopieras värdet till urklipp.



 

Skapa Client ID och hemlig nyckel

DeliveryCloud API kräver användning av tokens (Client IDs och Client Secrets).

Börja med att skapa det Client ID och den hemliga nyckel som behövs för autentisering.

  1. Logga in på nShift Portal. (Om du inte använder ett Owner account kan du behöva begära åtkomst från Owner/Admin).
     
  2. Klicka på Settings längst upp till höger.

    nav-settings.png
     
  3. Välj API Configuration > Clients i menyn till vänster.
     
  4. Klicka på knappen Add på sidan Clients.
     
  5. Fyll i Display name och Description. Välj ett namn och en beskrivning som gör det enklare att identifiera tokenet senare. Markera kryssrutan Enable för att aktivera tokenet direkt. (Du kan när som helst aktivera eller inaktivera tokenet efter att det skapats).

    deliverycloud-client.png
     
  6. Välj Portal Shipment Data API under Allowed Scopes , vilket är de API:er du behöver åtkomst till. 
     
  7. Klicka på Save. Ditt Client ID och din Client Secret kommer nu att genereras och visas på skärmen. Viktigt: Din Client Secret kommer inte att vara tillgänglig efter att popup-fönstret stängs, så se till att kopiera den.
     
  8. Klicka på Close. Client ID kommer nu att visas på sidan Clients. Du kan när som helst klicka på ett Client ID för att redigera, ta bort eller aktivera/inaktivera det.

 

 

Begär ett token

Använd ditt Client ID och din Client Secret för att generera ett åtkomsttoken. Detta görs genom att skicka en POST-förfrågan till följande endpoint:
 

https://api.nshiftportal.com/delivery-cloud/idp/connect/token


Exempel:
POST https://api.nshiftportal.com/delivery-cloud/idp/connect/token
Cache-Control: no-cache
Host: www.nshiftportal.com 
Content-Type: application/x-www-form-urlencoded

client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&grant_type=client_credentials

 

Om förfrågan är giltig och klienten är korrekt konfigurerad får du ett JSON-svar:

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

Bearer-tokenet är giltigt i en timme. Alla förfrågningar måste innehålla tokenet i Authorization-headern.

 

 

Använda DeliveryCloud API

När du har autentiserats är du redo att börja använda DeliveryCloud API. Börja med att hämta listan över alla transportörer. Identifiera den transportör du vill använda och hämta tjänsterna och tilläggen för den transportören. När du har rätt ID:n för transportör, tjänst och tillägg är du redo att skapa försändelsen.

 

Översikt över metoder och steg som krävs för att lägga till dina försändelser i nShift Portal:

  1. Hämta en lista över alla transportörer och identifiera ID:t för den transportör du behöver.

    GET /metadata/carriers

    Obs: organizationId som används i denna förfrågan är det ID som du kopierade och sparade efter att du skapade Organization Unit. 
     

  2. Hämta en översikt över tjänsterna för en transportör. Använd transportör-ID:t som du fick från listan över transportörer.

    GET /metadata/carriers/{carrierId}/services

     

  3. Hämta en översikt över tillägg som är tillgängliga för en transportör. Använd transportör-ID:t som du fick från listan över transportörer. Tillägg används inte alltid, så detta steg är valfritt om dina försändelser inte har några tillägg.

    GET /metadata/carriers/{carrierId}/addons

     

  4. Skapa försändelser med hjälp av transportör-ID, tjänst-ID och addon-ID.

    PUT /shipments

    Obs: accountId som används i denna förfrågan är Member Account UUID som du kopierade och sparade efter att du skapade Organization Unit och Member Account. Kom ihåg att använda Member Account ID och inte Organization ID. 
     

Gå till den tekniska API-dokumentationen

Relaterade artiklar