Aanmelden

Ship Help Center

Client-ID en Client Secret aanmaken voor Ship API v2

Avatar
Malene Tidemann
Bijgewerkt

Het gebruik van de Ship API vereist het gebruik van tokens (Client IDs en Client Secrets). Dit artikel legt uit hoe je deze genereert. 


Houd er rekening mee dat alleen gebruikers met de rollen "owner" en "admin" toegang hebben tot de pagina API Configuration. Het wordt aanbevolen om een specifieke admin-gebruiker aan te maken voor API-interactie. Belangrijk: als de gebruiker die de inloggegevens heeft aangemaakt wordt verwijderd, werken de inloggegevens niet meer.

 

Een Client ID en Client Secret aanmaken

  1. Log in op nShift Portal met je owner-gebruiker.
     
  2. Kies Settings > API Configuration > Clients in het linkermenu.

    clients.png
     
  3. Klik op de pagina Clients op de knop Add.

    add-clients-api.png
     
  4. Vul in het dialoogvenster Display name en Description in. Kies een naam en beschrijving die het later makkelijker maken om de Client ID te herkennen. Vink Enabled aan om deze direct te activeren. (Je kunt de token later altijd in- of uitschakelen.)

    clientID-API.png
     
  5. Selecteer Shipment Server (public_api_shipmentserver) onder Allowed Scopes. Allowed scopes zijn de API’s waarvoor je toegang nodig hebt.
     
  6. Klik op Save. Je Client Id en Client Secret worden nu gegenereerd en op het scherm weergegeven. 
    Belangrijk: Noteer je Client ID en Client Secret. Client Secret is NIET meer beschikbaar nadat je het pop-upvenster sluit.

    client-secret-API.png
     
  7. Nadat je het pop-upvenster hebt gesloten, wordt de Client ID weergegeven op de pagina Clients. Je kunt op elk moment op een Client ID klikken om deze te bewerken of te verwijderen of om deze in of uit te schakelen. Als je veel ID’s hebt, kun je de filteroptie bovenaan gebruiken om alleen ingeschakelde of uitgeschakelde tokens te tonen.

     

Een toegangstoken verkrijgen

Gebruik je Client ID en Client Secret om een toegangstoken te genereren dat nodig is voor verzoeken naar de Ship API V2. Dit doe je door een POST-verzoek te sturen naar het volgende token-endpoint:

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

Geef de Client ID, Client Secret en grant type op in de taal en het framework dat je bedrijf gebruikt.


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

 

Als het verzoek geldig is en de client correct is geconfigureerd, ontvang je een JSON-response:

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

 

Se artiklen:  Hoe te - Authenticeren

Verwante artikelen