Logg på

nShift Help Center

Opprette Client ID og Client Secret for Ship API v2

Avatar
Malene Tidemann
Oppdatert

Bruk av Ship API krever bruk av tokens (Client IDs og Client Secrets). Denne artikkelen forklarer hvordan du genererer dem. 


Vær oppmerksom på at kun brukere med rollene "owner" og "admin" har tilgang til siden API Configuration. Det anbefales å opprette en egen admin-bruker for API-integrasjon. Viktig: Hvis brukeren som opprettet legitimasjonen slettes, vil legitimasjonen ikke lenger fungere.

Hvis du ikke er kjent med brukertyper og roller i nShift Ship, anbefaler vi å lese denne artikkelen: Understanding user types and roles. 



 

Opprette Client ID og Client Secret

  1. Logg inn på nShift Portal med din owner-bruker.
     
  2. Klikk på Settings øverst til høyre.

    nav-settings.png
     
  3. Velg API Configuration > Clients i menyen til venstre.
     
  4. På siden Clients, klikk på knappen Add.

    add-clients-api.png
     
  5. I dialogboksen fyller du inn Display name og Description. Velg et navn og en beskrivelse som gjør det enklere å identifisere Client ID senere. Kryss av for Enabled for å aktivere den med én gang. (Du kan når som helst aktivere eller deaktivere tokenet senere.)

    clientID-API.png
     
  6. Velg Shipment Server (public_api_shipmentserver) under Allowed Scopes. Allowed scopes 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: Noter din Client ID og Client Secret. Client Secret vil IKKE være tilgjengelig etter at du lukker popup-vinduet.

    client-secret-API.png
     
  8. Når du lukker popup-vinduet, vil Client ID vises på siden Clients. Du kan når som helst klikke på en Client ID for å redigere eller slette den eller for å aktivere/deaktivere den. Hvis du har mange ID-er, kan du bruke filteret øverst for å vise kun aktiverte eller deaktiverte tokens.

     

Hente et tilgangstoken

Bruk din Client ID og Client Secret til å generere et tilgangstoken som trengs for forespørsler til Ship API V2. Dette gjøres ved å sende en POST-forespørsel til følgende token-endpoint:

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

Spesifiser Client ID, Client Secret og grant type i språket og rammeverket som brukes i din virksomhet.


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

 

Hvis forespørselen er gyldig og klienten er korrekt konfigurert, vil du få et JSON-svar tilbake:

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

 

Se artikkelen:  How to - Authenticate

Relaterte artikler