Log ind

nShift Help Center

Kom godt i gang med nShift Checkout API

Avatar
Malene Tidemann
Opdateret

nshift-checkout-label.png


nShift Checkout API er en integrationstjeneste til kommunikation mellem nShift Checkout og din webshop. nShift Checkout API bruger et REST API-framework til kommunikation med JSON som databærer og tilbyder flere funktioner.

For at komme i gang med at bruge API’et skal du gennemgå nedenstående trin, eller du kan gå direkte til den tekniske dokumentation her.

  1. Opret Client ID og secret
  2. Anmod om et token
  3. Opret en session
  4. Kald endpointet for leveringsmuligheder
  5. Opret en delvis forsendelse
  6. API-dokumentation

 

1. Opret Client ID og secret

Start med at oprette Client ID og secret, der er nødvendige til godkendelse.

  1. Log ind på nShift Portal med din ejerbruger.
     
  2. Klik på Settings i øverste venstre hjørne, og naviger til API Configuration > Client.
     
  3. På siden Clients skal du klikke på knappen Add.

    add-clients-api.png
     
  4. Udfyld Display name og Description. Vælg et navn og en beskrivelse, som gør det lettere at identificere tokenet senere. Markér afkrydsningsfeltet Enable for at aktivere tokenet med det samme. (Du kan aktivere eller deaktivere tokenet når som helst efter oprettelsen).

    client-id.png
     
  5. Vælg Public checkout API under Allowed Scopes, som er de API’er, du har brug for adgang til. 
     
  6. Klik på Save. Dit Client ID og Client Secret bliver nu genereret og vist på skærmen. Vigtigt: Client Secret vil ikke være tilgængeligt, efter du lukker pop op-vinduet, så sørg for at kopiere det.

    client-secret.png
     
  7. Klik på Close. Client ID’et 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.

 

 

2. Anmod om et token

Brug dit Client ID og Client Secret til at generere et adgangstoken. Dette gøres ved at sende en POST-anmodning 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 anmodningen er gyldig, og klienten er korrekt konfigureret, får du et JSON-response tilbage:

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

Bearer-tokenet er gyldigt i én time.

 

 

3. Opret en session

Brug bearer-tokenet til at kalde session-endpointet i nShift Checkout. Send en POST-anmodning til:

 

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

 

Brug Connection ID som path-parameter. Gå til Connections i topmenuen, og find dit Connection ID på listen. (Læs mere om Connections her).

connection-id.png


POST-kaldet opretter en session, der er gyldig i 4 timer, medmindre den bruges i løbet af denne periode. Sessionen vil indeholde oplysninger fra din checkout-konfiguration, f.eks. afsenderoplysninger. Hvis du ønsker at ændre, hvilken Checkout-konfiguration du bruger til at hente leveringsmuligheder, kan du blot ændre, hvilken konfiguration connection ID’et peger på.

 

For at ændre hvilken Checkout-konfiguration et connection ID peger på, skal du gå til Connections i topmenuen og klikke på den connection, du vil ændre. Vælg en anden Checkout i rullemenuen Configuration, og klik på Save.

change-config.png

 

 

4. Kald endpointet for leveringsmuligheder

Ved hjælp af session-ID’et kan du sende et POST-kald til endpointet for leveringsmuligheder:


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

 

Request body til endpointet for leveringsmuligheder indeholder oplysninger om modtageren, pakken/pakkerne og andre ekstra data, der kan påvirke tilgængelige leveringsmuligheder. Responsen indeholder en liste over tilgængelige leveringsmuligheder. Hvis du bruger nShift Checkout-widgetten, skal disse data sendes til den korrekte metode for at vise leveringsmulighederne.

 

 

5. Opret en delvis forsendelse

Når din slutkunde har valgt en leveringsmulighed, kan du oprette en delvis forsendelse i din Book and Print-platform (nShift Delivery, nShift Ship eller nShift Transsmart).

 

Send et POST-kald til:
 

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


For mere information, se API-dokumentationen.

Request body til dette kald indeholder session-ID’et, det valgte ID for leveringsmuligheden og andre oplysninger om forsendelsen, såsom ordre-ID’et, som vil være den unikke identifikator, du bruger til at finde den delvise forsendelse i Book and Print-platformen. Request body indeholder også oplysninger om modtageren. Du kan ændre nogle af modtageroplysningerne (nogle værdier, såsom postnummer, kan ikke ændres på grund af deres påvirkning af tilgængelige leveringsmuligheder).

Kaldet vil resultere i en oprettet delvis forsendelse i Book and Print-platformen for den valgte leveringsmulighed. For at omdanne den delvise forsendelse til en faktisk forsendelse skal du kalde de tilknyttede endpoints i de respektive Book and Print-platforme.

 

 

API-dokumentation

Vores tekniske API-dokumentation er tilgængelig her:
 

Gå til API-dokumentationen

Relaterede artikler