Logg på

nShift Help Center

Kom i gang med nShift Checkout API

Avatar
Malene Tidemann
Oppdatert

nshift-checkout-label.png


nShift Checkout API er en integrasjonstjeneste for kommunikasjon mellom nShift Checkout og nettbutikken din. nShift Checkout API bruker et REST API-rammeverk for kommunikasjon med JSON som databærer og tilbyr flere funksjoner.

For å komme i gang med å bruke API-et må du følge trinnene nedenfor, eller du kan gå direkte til den tekniske dokumentasjonen her.

  1. Opprett Client ID og secret
  2. Be om et token
  3. Opprett en sesjon
  4. Kall endpointet for leveringsalternativer
  5. Opprett en delvis forsendelse
  6. API-dokumentasjon

 

1. Opprett Client ID og secret

Start med å opprette Client ID og secret som kreves for autentisering.

  1. Logg inn på nShift Portal med owner-brukeren din.
     
  2. Klikk på Settings øverst til venstre og naviger til API Configuration > Client.
     
  3. På siden Clients klikker du på knappen Add.

    add-clients-api.png
     
  4. 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 aktivere eller deaktivere tokenet når som helst etter opprettelsen).

    client-id.png
     
  5. Velg Public checkout API under Allowed Scopes, som er API-ene du trenger tilgang til. 
     
  6. Klikk på Save. Client ID og Client Secret blir nå generert og vist på skjermen. Viktig: Client Secret vil ikke være tilgjengelig etter at du lukker popup-vinduet, så sørg for å kopiere det.

    client-secret.png
     
  7. 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 eller slette den eller for å aktivere/deaktivere den.

 

 

2. Be om et token

Bruk Client ID og Client Secret til å generere et tilgangstoken. Dette gjøres ved å sende en POST-forespørsel til følgende endpoint:

 

https://account.nshiftportal.com/idp/connect/token


Eksempel:
POST https://account.nshiftportal.com/idp/connect/token
Cache-Control: no-cache
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 riktig konfigurert, vil du få et JSON-response tilbake:

{
    "access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsoidfgvoiltgjvpdrofjmwpkldujrftvoifgkhbnilsakjprotglijkqp2owrlfjkvmowrifgho2qw9ouejifpe9rodtuj3-0porfij9odtujgw0etioyh",
    "expires_in": 3600,
    "token_type": "Bearer"
}

Bearer-tokenet er gyldig i én time.

 

 

3. Opprett en sesjon

Bruk bearer-tokenet til å kalle session-endpointet i nShift Checkout. Send en POST-forespørsel til:

 

https://www.nshiftportal.com/checkout/options/v1/sessions/{checkoutConnectionId}

 

Bruk Connection ID som path-parameter. Gå til Connections i toppmenyen og finn Connection ID-en din i listen. (Les mer om Connections her).

connection-id.png


POST-kallet oppretter en sesjon som er gyldig i 4 timer, med mindre den brukes i løpet av denne perioden. Sesjonen vil inneholde informasjon fra checkout-konfigurasjonen din, for eksempel avsenderinformasjon. Hvis du ønsker å endre hvilken Checkout-konfigurasjon du bruker for å hente leveringsalternativer, kan du ganske enkelt endre hvilken konfigurasjon connection ID-en peker til.

 

For å endre hvilken Checkout-konfigurasjon en connection ID peker til, går du til Connections i toppmenyen og klikker på connectionen du vil endre. Velg en annen Checkout i nedtrekksmenyen Configuration og klikk på Save.

change-config.png

 

 

4. Kall endpointet for leveringsalternativer

Ved hjelp av session ID-en kan du sende et POST-kall til endpointet for leveringsalternativer:


https://www.nshiftportal.com/checkout/options/v1/shipping-options/{sessionId}

 

Request body til endpointet for leveringsalternativer inneholder informasjon om mottakeren, pakken/pakkene og andre tilleggsdata som kan påvirke tilgjengelige leveringsalternativer. Responsen inneholder en liste over tilgjengelige leveringsalternativer. Hvis du bruker nShift Checkout-widgeten, må disse dataene sendes til riktig metode for å vise leveringsalternativene.

 

 

5. Opprett en delvis forsendelse

Når sluttkunden din har valgt et leveringsalternativ, kan du opprette en delvis forsendelse i Book and Print-plattformen din (nShift Delivery, nShift Ship eller nShift Transsmart).

 

Send et POST-kall til:
 

https://www.nshiftportal.com/checkout/shipments/v1/shipments


For mer informasjon, se API-dokumentasjonen.

Request body til dette kallet inneholder session ID-en, valgt ID for leveringsalternativet og annen informasjon om forsendelsen, for eksempel order ID-en, som vil være den unike identifikatoren du bruker for å finne den delvise forsendelsen i Book and Print-plattformen. Request body inneholder også informasjon om mottakeren. Du kan endre noen av mottakeropplysningene (noen verdier, som postnummer, kan ikke endres på grunn av deres påvirkning på tilgjengelige leveringsalternativer).

Kallet vil resultere i en opprettet delvis forsendelse i Book and Print-plattformen for det valgte leveringsalternativet. For å gjøre den delvise forsendelsen om til en faktisk forsendelse må du kalle de tilknyttede endpointene i de respektive Book and Print-plattformene.

 

 

API-dokumentasjon

Vår tekniske API-dokumentasjon er tilgjengelig her:
 

Gå til API-dokumentasjonen

Relaterte artikler