Logg på

nShift Help Center

Komme i gang med DeliveryCloud API

Avatar
Malene Tidemann
Oppdatert

Leter du etter en måte å samle alle forsendelsesdataene dine på ett sentralt sted, selv om du arbeider med flere ulike book- og print-produkter? Med DeliveryCloud API fra nShift kan du integrere alle forsendelsene dine i nShift Portal. Dette gjør det enkelt å administrere og spore forsendelsene dine, samtidig som du får tilgang til omfattende rapportering og avanserte sporingsverktøy, noe som gir bedre synlighet gjennom hele forsendelsesprosessen.

 

Innhold i denne artikkelen:

 

Viktigste bruksområder

Kundene våre har mange ulike oppsett og løsninger, noe som skaper forskjellige bruksområder for DeliveryCloud API. Her er noen eksempler på de viktigste bruksområdene:

 

Bruksområde 1: Flere forsendelsesflyter

Kunden kan bruke en nShift book- og print-løsning sammen med nShift Track, men har også en dropshipping-flyt som bruker en annen book- og print-løsning. Med DeliveryCloud API kan kunden sende forsendelser fra dropshipping-flyten inn i nShift Portal og bruke Track for alle forsendelser.

 

Bruksområde 2: Emissions Tracker

Kunden ønsker å bruke nShift Emissions Tracker, men ikke alle forsendelser opprettes ved hjelp av et nShift book- og print-produkt. Ved hjelp av DeliveryCloud API kan de sende inn alle forsendelser og få utslippsberegninger.

 

Bruksområde 3: Bruk av en ikke-nShift book- og print-løsning

Kunden bruker en ikke-nShift book- og print-løsning, men ønsker å kjøpe nShift Track. Ved hjelp av DeliveryCloud API kan de sende alle forsendelser som er booket i et annet system og få fordelene med nShift Track.

 

 

Opprett en DeliveryCloud-organisasjon

Start med å opprette en Organization og et Member Account Name i nShift Portal. Dette er stedet der forsendelsene vil bli opprettet. Merk at du må opprette en Organization Unit og en Member account spesielt for DeliveryCloud, selv om du allerede har en eksisterende medlemskonto i nShift Portal.

  1. Logg inn på nShift Portal og klikk på Settings øverst til venstre.
     
  2. Velg Company Management > Delivery Cloud Configuration. (Hvis du ikke ser dette alternativet, må du kontakte nShift Customer Service for å få det aktivert).


     
  3. Klikk på Create og deretter på Add Organization Unit.


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


     
  5. Klikk på Save.
     
  6. Husk å kopiere og lagre Organization ID og Member Account ID, siden disse verdiene er nødvendige for API-forespørsler. Hvis du velger Copy ID, kopieres verdien til utklippstavlen.



 

Opprett Client ID og hemmelig nøkkel

DeliveryCloud API krever bruk av tokens (Client IDs og Client Secrets).

Start med å opprette Client ID og den hemmelige nøkkelen som er nødvendig for autentisering.

  1. Logg inn på nShift Portal. (Hvis du ikke bruker en Owner account, må du kanskje be om tilgang fra Owner/Admin).
     
  2. Klikk på Settings øverst til høyre.

    nav-settings.png
     
  3. Velg API Configuration > Clients i menyen til venstre.
     
  4. Klikk på knappen Add på siden Clients.
     
  5. Fyll inn Display name og Description. Velg et navn og en beskrivelse som gjør det enklere å identifisere tokenet senere. Kryss av for Enable for å aktivere tokenet umiddelbart. (Du kan når som helst aktivere eller deaktivere tokenet etter at det er opprettet).

    deliverycloud-client.png
     
  6. Velg Portal Shipment Data API under Allowed Scopes, som er API-ene du trenger tilgang til. 
     
  7. Klikk på Save. Din Client ID og Client Secret blir nå generert og vist på skjermen. Viktig: Client Secret vil ikke være tilgjengelig etter at popup-vinduet lukkes, så sørg for å kopiere den.
     
  8. Klikk på Close. Client ID vil nå bli vist på siden Clients. Du kan når som helst klikke på en Client ID for å redigere, slette eller aktivere/deaktivere den.

 

 

Be om et token

Bruk din Client ID og Client Secret til å generere et tilgangstoken. Dette gjøres ved å sende en POST-forespørsel 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 forespørselen er gyldig og klienten er korrekt konfigurert, vil du motta et JSON-svar:

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

Bearer-tokenet er gyldig i én time. Alle forespørsler må inneholde tokenet i Authorization-headeren.

 

 

Bruk av DeliveryCloud API

Når du er autentisert, er du klar til å begynne å bruke DeliveryCloud API. Start med å hente listen over alle transportører. Identifiser transportøren du vil bruke, og hent tjenester og tillegg for den aktuelle transportøren. Når du har riktige ID-er for transportør, tjeneste og tillegg, er du klar til å opprette forsendelsen.

 

Oversikt over metodene og trinnene som er nødvendige for å legge til forsendelsene dine i nShift Portal:

  1. Hent en liste over alle transportører og identifiser ID-en til transportøren du trenger.

    GET /metadata/carriers

    Merk: organizationId som brukes i denne forespørselen er ID-en du kopierte og lagret etter opprettelsen av Organization Unit. 
     

  2. Hent en oversikt over tjenestene for en transportør. Bruk transportør-ID-en du fikk fra listen over transportører.

    GET /metadata/carriers/{carrierId}/services

     

  3. Hent en oversikt over tillegg som er tilgjengelige for en transportør. Bruk transportør-ID-en du fikk fra listen over transportører. Tillegg brukes ikke alltid, så dette trinnet er valgfritt hvis forsendelsene dine ikke har tillegg.

    GET /metadata/carriers/{carrierId}/addons

     

  4. Opprett forsendelser ved hjelp av transportør-ID, tjeneste-ID og addon-ID.

    PUT /shipments

    Merk: accountId som brukes i denne forespørselen er Member Account UUID-en som du kopierte og lagret etter opprettelsen av Organization Unit og Member Account. Husk å bruke Member Account ID og ikke Organization ID. 
     

Gå til den tekniske API-dokumentasjonen

Relaterte artikler