Svenska Dansk English Suomi Nederlands Norsk



nShift DeliveryHub Help

Sök i nShift DeliveryHub Help

API-konfiguration

Avatar
Malene Tidemann
Uppdaterad

Om du använder ett API i Consignor Portal som kräver användning av tokens (klient-ID och klientlösenord) kommer den här artikeln att förklara hur du genererar dem. 

Observera att endast ”ägare” och ”admin” har åtkomst till API-konfigurationssidan. Vi rekommenderar att du skapar en egen administratörsanvändare för API-interaktion. För API:er med försändelsedata skulle det till exempel göra det möjligt att anpassa Shipment Viewer-profilen för att matcha den data du vill returnera utan att det påverkar andra användares gränssnittskonfiguration.


Om du inte känner till vilka användartyper och roller som används i Consignor rekommenderar vi att du läser följande artikel: Förstå användartyper och roller.

Vi rekommenderar att använda HTTPS (minst version TLS 1.2) för alla portalens API:er för att de ska fungera korrekt och ha förbättrad säkerhet med dessa produkter. Stöd för TLS 1.0 och 1.1 kommer att fasas ut i framtiden. TLS 1.0 och 1.1 är omoderna protokoll som inte stöder moderna kryptografiska algoritmer, och har svagheter i säkerheten som hackare kan utnyttja.

 

 

Skapa ett Client ID och Client Secret

  1. Logga in i Portal med din ägaranvändare.

  2. Klicka på ditt namn högst upp till höger och välj Settings.

    um1.png

  3. Välj API Configuration > Clients i menyn till vänster.

    mceclip2.png

  4. På sidan Clients klickar du på knappen Add.

    mceclip3.png

  5. I den dialogruta som öppnas fyller du i Display name och Description. Välj ett namn och en beskrivning som gör det lättare att identifiera din token senare. Kryssa i rutan Enable för att aktivera din token direkt. (Du kan aktivera eller inaktivera din token när som helst efter att den har skapats.)

    mceclip6.png

  6. Markera Allowed Scopes. Vi rekommenderar att du alltid inkluderar OpenId och väljer de API-alternativ som du behöver. 

    mceclip7.png

  7. Klicka på Save. Client Id och Client Secret kommer nu att genereras och visas på skärmen. Viktigt: Skriv upp dina tokens eftersom Client Secret inte kommer kunna ses igen när du har stängt popup-fönstret.

    mceclip8.png

  8. Klicka på Save för att slutföra.

  9. Din token kommer nu att visas på sidan Clients. Du kan när som helst klicka på en token för att redigera eller ta bort den eller för att aktivera/inaktivera den.  Om du har en lång lista med tokens kan du använda filteralternativet längst upp för att endast visa aktiverade eller inaktiverade tokens.

    mceclip11.png

 

Få ett åtkomsttoken

Använd ditt Client ID och Client Secret för att generera ett åtkomsttoken som behövs för andra förfrågningar till vårt API. Detta görs genom att göra en HTTP POST till följande token-slutpunkt:

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

Ange Client ID, Client Secret och behörighetstyp på det språk och ramverk som används av ditt företag.


Exempel:

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


Om begäran är giltig och klienten är korrekt konfigurerad får du ett JSON-svar.

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

 

Vidare läsning

Alla våra nya API:er kommer att stödja en OpenID-lösning för förbättrad säkerhet. För mer information, se standarddokumentation för OpenId och IdentityServer:

Relaterade artiklar