Logga in

nShift Help Center

Skapa ett Client ID och Client Secret för Ship API v2

Avatar
Malene Tidemann
Uppdaterad

Användning av Ship API kräver användning av tokens (Client IDs och Client Secrets). Den här artikeln förklarar hur du genererar dem. 


Observera att endast användare med rollerna "owner" och "admin" har tillgång till sidan API Configuration. Det rekommenderas att skapa en särskild admin-användare för API-interaktion. Viktigt: om användaren som skapade autentiseringsuppgifterna tas bort kommer dessa inte längre att fungera.


 

Skapa ett Client ID och Client Secret

  1. Logga in på nShift Portal med din owner-användare.
     
  2. Klicka på Settings uppe till höger.

    nav-settings.png
     
  3. Välj API Configuration > Clients i menyn till vänster.
     
  4. På sidan Clients, klicka på knappen Add.

    add-clients-api.png
     
  5. I dialogrutan fyller du i Display name och Description. Välj ett namn och en beskrivning som gör det lättare att identifiera Client ID senare. Markera Enabled för att aktivera det direkt. (Du kan när som helst aktivera eller inaktivera token efter att det har skapats.)

    clientID-API.png
     
  6. Välj Shipment Server (public_api_shipmentserver) under Allowed Scopes. Allowed scopes är de API:er du behöver åtkomst till.
     
  7. Klicka på Save. Ditt Client Id och Client Secret genereras nu och visas på skärmen. 
    Viktigt: Anteckna ditt Client ID och Client Secret. Client Secret kommer INTE att vara tillgängligt efter att du stänger popup-fönstret.

    client-secret-API.png
     
  8. När du stänger popup-fönstret visas Client ID 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. Om du har en lång lista med ID:n kan du använda filteralternativet högst upp för att endast visa aktiverade eller inaktiverade tokens.

     

Hämta en åtkomsttoken

Använd ditt Client ID och Client Secret för att generera en åtkomsttoken som behövs för anrop till Ship API V2. Detta görs genom att skicka en POST-förfrågan till följande token-endpoint:

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

Ange Client ID, Client Secret och grant type i det språk och ramverk som används av ditt företag.


Exempel:
POST https://account.nshiftportal.com/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

 

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

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

 

Se artikeln: How to - Authenticate

Relaterade artiklar