Logga in

nShift Help Center

Kom igång med nShift Checkout API

Avatar
Malene Tidemann
Uppdaterad

nshift-checkout-label.png


nShift Checkout API är en integrationstjänst för kommunikation mellan nShift Checkout och din webshop. nShift Checkout API använder ett REST API-ramverk för kommunikation med JSON som databärare och erbjuder flera funktioner.

För att komma igång med API:et behöver du följa stegen nedan, eller så kan du gå direkt till den tekniska dokumentationen här.

  1. Skapa Client ID och secret
  2. Begär en token
  3. Skapa en session
  4. Anropa endpointen för leveransalternativ
  5. Skapa en partiell försändelse
  6. API-dokumentation

 

1. Skapa Client ID och secret

Börja med att skapa Client ID och secret som krävs för autentisering.

  1. Logga in på nShift Portal med din owner-användare.
     
  2. Klicka på Settings uppe till vänster och navigera till API Configuration > Client.
     
  3. På sidan Clients klickar du på knappen Add.

    add-clients-api.png
     
  4. Fyll i Display name och Description. Välj ett namn och en beskrivning som gör det enklare att identifiera tokenen senare. Markera kryssrutan Enable för att aktivera tokenen direkt. (Du kan aktivera eller inaktivera tokenen när som helst efter att den skapats).

    client-id.png
     
  5. Välj Public checkout API under Allowed Scopes, vilket är de API:er du behöver åtkomst till. 
     
  6. Klicka på Save. Ditt Client ID och Client Secret genereras nu och visas på skärmen. Viktigt: Client Secret kommer inte vara tillgängligt efter att du stängt popup-fönstret, så se till att kopiera det.

    client-secret.png
     
  7. 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 eller ta bort det eller för att aktivera/inaktivera det.

 

 

2. Begär en token

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

 

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


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

 

Om förfrågan är giltig och klienten är korrekt konfigurerad får du tillbaka en JSON-response:

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

Bearer-tokenen är giltig i en timme.

 

 

3. Skapa en session

Använd bearer-tokenen för att anropa session-endpointen i nShift Checkout. Skicka en POST-förfrågan till:

 

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

 

Använd Connection ID som path-parameter. Gå till Connections i toppmenyn och hitta ditt Connection ID i listan. (Läs mer om Connections här).

connection-id.png


POST-anropet skapar en session som är giltig i 4 timmar, såvida den inte används under denna period. Sessionen kommer att innehålla information från din checkout-konfiguration, till exempel avsändarinformation. Om du vill ändra vilken Checkout-konfiguration du använder för att hämta leveransalternativ kan du enkelt ändra vilken konfiguration connection ID:t pekar på.

 

För att ändra vilken Checkout-konfiguration ett connection ID pekar på går du till Connections i toppmenyn och klickar på den connection du vill ändra. Välj en annan Checkout i rullgardinsmenyn Configuration och klicka på Save.

change-config.png

 

 

4. Anropa endpointen för leveransalternativ

Med hjälp av session ID:t kan du skicka ett POST-anrop till endpointen för leveransalternativ:


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

 

Request body till endpointen för leveransalternativ innehåller information om mottagaren, paketet/paketen och annan extra data som kan påverka tillgängliga leveransalternativ. Responsen innehåller en lista över tillgängliga leveransalternativ. Om du använder nShift Checkout-widgeten måste dessa data skickas till rätt metod för att visa leveransalternativen.

 

 

5. Skapa en partiell försändelse

När din slutkund har valt ett leveransalternativ kan du skapa en partiell försändelse i din Book and Print-plattform (nShift Delivery, nShift Ship eller nShift Transsmart).

 

Skicka ett POST-anrop till:
 

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


För mer information, se API-dokumentationen.

Request body för detta anrop innehåller session ID:t, valt ID för leveransalternativet och annan information om försändelsen, såsom order-ID:t, vilket kommer att vara den unika identifieraren du använder för att hitta den partiella försändelsen i Book and Print-plattformen. Request body innehåller också information om mottagaren. Du kan ändra vissa mottagaruppgifter (vissa värden, såsom postnummer, kan inte ändras på grund av deras påverkan på tillgängliga leveransalternativ).

Anropet kommer att resultera i en skapad partiell försändelse i Book and Print-plattformen för det valda leveransalternativet. För att omvandla den partiella försändelsen till en faktisk försändelse måste du anropa de tillhörande endpointsen i respektive Book and Print-plattform.

 

 

API-dokumentation

Vår tekniska API-dokumentation finns tillgänglig här:
 

Gå till API-dokumentationen

Relaterade artiklar