Hvis du bruger et API i Portal, som kræver brug af tokens (Client IDs og Client Secrets), vil denne artikel forklare, hvordan du genererer det.
Bemærk venligst, at kun brugere med en "owner" (ejer) eller "admin" profil har adgang til API konfigurationssiden. Vi anbefaler at oprette en specifik admin bruger til API interaktion. For Shipment Data API'et vil det eksempelvis betyde, at du vil kunne tilpasse shipment viewer profilen, så den matcher de præcise data, du ønsker at vise, uden at det påvirker andre brugeres brugergrænseflade.
Hvis du ikke er bekendt med de brugertyper og roller der bruges i DeliveryHub, anbefaler vi, at du læser denne artikel: Forstå brugertyper og roller
Vores anbefaling til alle Portal API'er er at bruge HTTPS (version TLS 1.2 minimum) for at fungere korrekt og have forbedret sikkerhed med disse produkter. Understøttelse af TLS 1.0 og 1.1 vil blive udfaset i fremtiden. TLS 1.0 og 1.1 er forældede protokoller, der ikke understøtter moderne kryptografiske algoritmer, og de indeholder sikkerhedssårbarheder, der kan udnyttes af hackere.
Opret et Client ID og Client Secret
- Log ind på Portal med din "owner" brugerprofil.
- Klik på dit navn i øverste højre hjørne og vælg Settings.
- Vælg API Configuration > Clients i menuen i venstre side.
- Klik på Add-knappen på Clients siden.
- Udfyld Display name og Description i dialogboksen, der åbnes. Vælg et navn og en beskrivelse, som vil gøre det nemmere at identificere en bestemt token på et senere tidspunkt. Markér feltet Enabled for at aktivere din token med det samme. (Du kan aktivere eller deaktivere en token når som helst efter oprettelsen).
- Foretag de relevante valg under Allowed Scopes, som er de områder hvor dit token skal bruges. Vi anbefaler altid at medtage OpenId og vælge de API indstillinger som du har brug for.
- Klik på Save. Dit Client Id og Client Secret genereres nu og vises på skærmen. Vigtigt: Notér dine tokens, da Client Secret ikke vil være tilgængelig, når du har lukket popup vinduet.
- Klik Save for at afsluttet oprettelse af din token.
- Din token vil nu fremgå på Clients siden. Du kan når som helst klikke på en token for at redigere eller slette den eller aktivere/ deaktivere den. Hvis du har en lang liste med tokens, kan du bruge filteret i toppen og kun få vist aktiverede eller deaktiverede tokens.
Opret en access token
Brug dit Client ID og Client Secret til at generere en access token, som skal bruges ved andre requests til vores API. Dette gøre ved at lave en POST request til følgende token endpoint:
https://www.consignorportal.com/idsrv/connect/token
Specificér Client ID, Client Secret og grant type i det sprog og framework, som benyttes af din virksomhed.
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 requesten er gyldig og klienten er korrekt konfigureret, får du et JSON-svar tilbage:
{
"access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsoidfgvoiltgjvpdrofjmwpkldujrftvoifgkhbnilsakjprotglijkqp2owrlfjkvmowrifgho2qw9ouejifpe9rodtuj3-0porfij9odtujgw0etioyh",
"expires_in": 3600,
"token_type": "Bearer"
}
Mere information
Alle vores nye API'er understøtter en OpenID-løsning for forbedre sikkerheden. For mere information, se OpenId og IdentityServer standarddokumentation: