Log ind

nShift Help Center

Oprettelse af Client ID og Client Secret til Ship API v2

Avatar
Malene Tidemann
Opdateret

Brug af Ship API kræver brug af tokens (Client IDs og Client Secrets). Denne artikel forklarer, hvordan du genererer dem. 


Bemærk, at kun brugere med rollen "owner" og "admin" har adgang til siden API Configuration. Det anbefales at oprette en specifik admin-bruger til API-interaktion. Vigtigt: Hvis brugeren, der oprettede legitimationsoplysningerne, slettes, vil legitimationsoplysningerne ikke længere fungere.


 

Oprettelse af Client ID og Client Secret

  1. Log ind på nShift Portal med din owner-bruger.
     
  2. Klik på Settings øverst til højre.

    nav-settings.png
     
  3. Vælg API Configuration > Clients i menuen til venstre.
     
  4. På siden Clients skal du klikke på knappen Add.

    add-clients-api.png
     
  5. I dialogboksen skal du udfylde Display name og Description. Vælg et navn og en beskrivelse, der gør det nemmere at identificere Client ID’et senere. Sæt flueben i Enabled for at aktivere det med det samme. (Du kan til enhver tid aktivere eller deaktivere tokenet efter oprettelsen.)

    clientID-API.png
     
  6. Vælg Shipment Server (public_api_shipmentserver) under Allowed Scopes. Allowed scopes er de API’er, du har brug for adgang til.
     
  7. Klik på Save. Dit Client Id og Client Secret bliver nu genereret og vist på skærmen. 
    Vigtigt: Notér dit Client ID og Client Secret. Client Secret vil IKKE være tilgængeligt, efter du lukker popup-vinduet.

    client-secret-API.png
     
  8. Når du lukker popup-vinduet, vil Client ID’et 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. Hvis du har en lang liste af ID’er, kan du bruge filterfunktionen øverst til kun at vise aktiverede eller deaktiverede tokens.

     

Hent en adgangstoken

Brug dit Client ID og Client Secret til at generere en adgangstoken, som er nødvendig for forespørgsler til Ship API V2. Dette gøres ved at sende en POST-forespørgsel til følgende token-endpoint:

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

Angiv Client ID, Client Secret og grant type i det sprog og framework, din virksomhed bruger.


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ørgslen er gyldig, og klienten er korrekt konfigureret, vil du få et JSON-svar tilbage:

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

 

Se artiklen:  Sådan gør du - Autentificering

Relaterede artikler