Log ind

nShift Help Center

Kom godt i gang med DeliveryCloud API

Avatar
Malene Tidemann
Opdateret

Leder du efter en måde at samle alle dine forsendelsesdata ét centralt sted, selvom du arbejder med flere forskellige book- og print-produkter? Med nShifts DeliveryCloud API kan du integrere alle dine forsendelser i nShift Portal. Dette giver dig mulighed for nemt at administrere og spore dine forsendelser, samtidig med at du får adgang til omfattende rapportering og avancerede sporingsværktøjer, hvilket sikrer bedre synlighed på tværs af hele din forsendelsesproces.

 

Indhold i denne artikel:

 

Primære use cases

Vores kunder har mange forskellige opsætninger og løsninger, hvilket skaber forskellige anvendelsestilfælde for DeliveryCloud API. Her er nogle eksempler på de vigtigste anvendelsestilfælde:

 

Use case 1: Flere forsendelsesflows

Kunden bruger måske en nShift book- og print-løsning sammen med nShift Track, men har også et dropshipping-flow, der bruger en anden book- og print-løsning. Med DeliveryCloud API kan kunden sende forsendelser fra dropshipping-flowet ind i nShift Portal og bruge Track til alle forsendelser.

 

Use case 2: Emissions Tracker

Kunden ønsker at bruge nShift Emissions Tracker, men ikke alle forsendelser oprettes ved hjælp af et nShift book- og print-produkt. Ved hjælp af DeliveryCloud API kan de sende alle forsendelser ind og få emissionsberegninger.

 

Use case 3: Brug af en ikke-nShift book- og print-løsning

Kunden bruger en ikke-nShift book- og print-løsning, men ønsker at købe nShift Track. Ved hjælp af DeliveryCloud API kan de sende alle forsendelser booket i et andet system og få fordelene ved nShift Track.

 

 

Opret en DeliveryCloud-organisation

Start med at oprette en Organization og et Member Account Name i nShift Portal. Dette er placeringen, hvor forsendelserne vil blive oprettet. Bemærk, at du skal oprette en Organization Unit og en Member account specifikt til DeliveryCloud, selv hvis du allerede har en eksisterende medlemskonto i nShift Portal.

  1. Log ind på nShift Portal og klik på Settings øverst til venstre.
     
  2. Vælg Company Management > Delivery Cloud Configuration. (Hvis du ikke kan se denne mulighed, skal du kontakte nShift Customer Service for at få den aktiveret).


     
  3. Klik på Create og klik derefter på Add Organization Unit.


     
  4. Indtast et Organization Unit Name og et Member Account Name.


     
  5. Klik på Save.
     
  6. Husk at kopiere og gemme dit Organization ID og Member Account ID, da disse værdier er nødvendige til API-anmodningerne. Hvis du vælger Copy ID, kopieres værdien til udklipsholderen.



 

Opret Client ID og hemmelig nøgle

DeliveryCloud API kræver brug af tokens (Client IDs og Client Secrets).

Start med at oprette det Client ID og den hemmelige nøgle, der er nødvendige til autentificering.

  1. Log ind på nShift Portal. (Hvis du ikke bruger en Owner account, skal du muligvis anmode om adgang fra Owner/Admin).
     
  2. Klik på Settings øverst til højre.

    nav-settings.png
     
  3. Vælg API Configuration > Clients i menuen til venstre.
     
  4. Klik på knappen Add på siden Clients.
     
  5. Udfyld Display name og Description. Vælg et navn og en beskrivelse, der gør det nemmere at identificere tokenet senere. Marker afkrydsningsfeltet Enable for at aktivere tokenet med det samme. (Du kan til enhver tid aktivere eller deaktivere tokenet efter oprettelsen).

    deliverycloud-client.png
     
  6. Vælg Portal Shipment Data API under Allowed Scopes , som er de API’er, du har brug for adgang til. 
     
  7. Klik på Save. Dit Client ID og din Client Secret bliver nu genereret og vist på skærmen. Vigtigt: Client Secret vil ikke være tilgængelig efter at du lukker popup-vinduet, så sørg for at kopiere den.
     
  8. Klik på Close. Client ID vil nu blive vist på siden Clients. Du kan til enhver tid klikke på et Client ID for at redigere eller slette det eller for at aktivere/deaktivere det.

 

 

Anmod om et token

Brug dit Client ID og din Client Secret til at generere et adgangstoken. Dette gøres ved at sende en POST-anmodning til følgende endpoint:
 

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


Eksempel:
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

 

Hvis anmodningen er gyldig, og klienten er korrekt konfigureret, vil du få et JSON-svar retur:

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

Bearer-tokenet er gyldigt i én time. Alle anmodninger skal indeholde tokenet i Authorization-headeren.

 

 

Brug af DeliveryCloud API

Når du er autentificeret, er du klar til at begynde at bruge DeliveryCloud API. Start med at hente listen over alle transportører. Identificér den transportør, du vil bruge, og hent tjenesterne og tilføjelserne for den pågældende transportør. Når du har de korrekte ID’er til transportør, tjeneste og tilføjelser, er du klar til at oprette forsendelsen.

 

Oversigt over de metoder og trin, der er nødvendige for at tilføje dine forsendelser til nShift Portal:

  1. Hent en liste over alle transportører og identificér ID’et på den transportør, du har brug for.

    GET /metadata/carriers

    Bemærk: organizationId brugt i denne anmodning er det ID, du kopierede og gemte efter oprettelse af Organization Unit. 
     

  2. Hent en oversigt over tjenesterne for en transportør. Brug transportør-ID’et, du fik fra listen over transportører.

    GET /metadata/carriers/{carrierId}/services

     

  3. Hent en oversigt over tilføjelser, der er tilgængelige for en transportør. Brug transportør-ID’et, du fik fra listen over transportører. Tilføjelser bruges ikke altid, så dette trin er valgfrit, hvis dine forsendelser ikke har tilføjelser.

    GET /metadata/carriers/{carrierId}/addons

     

  4. Opret forsendelser ved hjælp af transportør-ID, service-ID og addon-ID.

    PUT /shipments

    Bemærk: accountId brugt i denne anmodning er det Member Account UUID, som du kopierede og gemte efter oprettelse af Organization Unit og Member Account. Husk at bruge Member Account ID og ikke Organization ID. 
     

Gå til den tekniske API-dokumentation

Relaterede artikler