Norsk Dansk English Suomi Nederlands Svenska



nShift DeliveryHub Help

Søk i nShift DeliveryHub Help

Konfigurasjon av API

Avatar
Malene Tidemann
Oppdatert

Hvis du bruker en API i Consignor Portal som krever at du bruker informasjonspakker, eller tokener («Client ID» og «Client Secret»), vil denne artikkelen forklare hvordan du genererer disse. 

Merk at kun Owner- og Admin-brukere har tilgang til konfigurasjonssiden for API. Det anbefales å opprette en spesifikk Admin-bruker for API-interaksjon. For eksempel vil dette på API-en for forsendelsesdata tillate deg å tilpasse Shipment Viewer-profilen til å matche de eksakte dataene du ønsker å returnere, uten at det påvirker andre brukeres konfigurasjon for brukergrensesnittet.


Hvis du ikke er kjent med brukertypene og -rollene som brukes i Consignor, anbefaler vi at du leser denne artikkelen: Forstå brukertyper og -roller.

Vår anbefaling for alle portal-API-er er å bruke HTTPS (minst versjon TLS 1.2) for å sørge for at disse produktene fungerer riktig og har forbedret sikkerhet. Støtte for TLS 1.0 og 1.1 vil etter hvert avvikles. TLS 1.0 og 1.1 er utdaterte protokoller som ikke støtter moderne kryptografiske algoritmer, og de har sårbarheter som kan utnyttes av angripere.

 

Oprette Client ID og Client Secret

  1. Logg deg på Portal med Owner-brukeren.

  2. Klikk på navnet ditt øverst til høyre, og velg Settings. 

    um1.png

  3. Velg API Configuration > Clients i menyen på venstre side.

    mceclip2.png

  4. På Clients-siden klikker du på Add-knappen.

    mceclip3.png

  5. I dialogboksen som dukker opp, angir du Display name og Description. Velg et navn og en beskrivelse som gjør det lettere å finne rett token senere. Merk av i boksen Enable hvis du vil aktivere tokenen med det samme. (Du kan aktivere og deaktivere en token når som helst etter opprettelse.)

    mceclip6.png

  6. Velg Allowed Scopes. Vi anbefaler at du alltid tar med OpenId og velger de API-alternativene du behøver. 

    mceclip0.png

  7. Klikk på Save. Nå opprettes Client Id og Client Secret, og du vil kunne se dem på skjermen. Viktig: Noter ned dine tokener, ettersom Client Secret ikke vil være tilgjengelig etter at popup-vinduet er lukket.

    mceclip8.png

  8. Klikk på Save for å fullføre opprettelsen.

  9. Denne tokenen finnes nå på siden Clients. Du kan klikke på en token når som helst for å redigere, slette, aktivere eller deaktivere den.  Hvis du har en lang liste med tokener, kan du bruke filtreringsfunksjonen øverst for å vise kun aktiverte eller kun deaktivere tokener.

    mceclip11.png

 

Slik skaffer du deg en tilgangstoken

Bruk Client ID og Client Secret til å generere en tilgangstoken. Du trenger denne til andre forespørsler du sender til API-en. Du gjør dette ved å lage en HTTP POST til følgende tokensluttpunkt:

https://www.consignorportal.com/idsrv/connect/token

Angi Client ID, Client Secret og rettighetstype i språket og rammeverket selskapet ditt bruker.


Eksempel:

POST https://www.consignorportal.com/idsrv/connect/token 
Cache-Control: no-cache
Host: www.consignorportal.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 riktig konfigurert, får du en JSON-respons.

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

 

Flere artikler

Alle våre nye API-er vil ha støtte for OpenID-løsninger som en ekstra sikkerhet. Du finner mer informasjon i dokumentasjonen til standardene OpenId og IdentityServer:

Relaterte artikler