Anmelden

Ship Help Center

Erstellen einer Client-ID und eines Client-Secret für Ship API v2

Avatar
Malene Tidemann
Aktualisiert

Die Nutzung der Ship API erfordert die Verwendung von Tokens (Client IDs und Client Secrets). Dieser Artikel erklärt, wie Sie diese erstellen. 


Bitte beachten Sie, dass nur Benutzer mit den Rollen "owner" und "admin" Zugriff auf die Seite API Configuration haben. Es wird empfohlen, einen eigenen Admin-Benutzer für die API-Interaktion zu erstellen. Wichtig: Wenn der Benutzer, der die Zugangsdaten erstellt hat, gelöscht wird, funktionieren diese nicht mehr.

 

Erstellen einer Client-ID und eines Client-Secret

  1. Melden Sie sich im nShift Portal mit Ihrem Owner-Benutzer an.
     
  2. Klicken Sie oben rechts auf Settings.

    nav-settings.png
     
  3. Wählen Sie im linken Menü API Configuration > Clients.
     
  4. Klicken Sie auf der Seite Clients auf die Schaltfläche Add.

    add-clients-api.png
     
  5. Geben Sie im Dialogfeld Display name und Description ein. Wählen Sie einen Namen und eine Beschreibung, die es erleichtern, die Client-ID später zu identifizieren. Aktivieren Sie Enabled, um sie sofort zu aktivieren. (Sie können das Token jederzeit nach der Erstellung aktivieren oder deaktivieren.)

    clientID-API.png
     
  6. Wählen Sie Shipment Server (public_api_shipmentserver) unter Allowed Scopes. Allowed Scopes sind die APIs, auf die Sie Zugriff benötigen.
     
  7. Klicken Sie auf Save. Ihre Client Id und Ihr Client Secret werden nun generiert und auf dem Bildschirm angezeigt. 
    Wichtig: Notieren Sie sich Ihre Client-ID und Ihr Client-Secret. Client Secret wird NICHT mehr verfügbar sein, nachdem Sie das Popup-Fenster geschlossen haben.

    client-secret-API.png
     
  8. Nachdem Sie das Popup-Fenster geschlossen haben, wird die Client-ID auf der Seite Clients angezeigt. Sie können jederzeit auf eine Client-ID klicken, um sie zu bearbeiten oder zu löschen oder um sie zu aktivieren/deaktivieren. Wenn Sie viele IDs haben, können Sie die Filteroption oben verwenden, um nur aktivierte oder deaktivierte Tokens anzuzeigen.

     

Abrufen eines Zugriffstokens

Verwenden Sie Ihre Client-ID und Ihr Client-Secret, um ein Zugriffstoken zu generieren, das für Anfragen an die Ship API V2 erforderlich ist. Dies erfolgt durch Senden einer POST-Anfrage an den folgenden Token-Endpunkt:

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

Geben Sie Client-ID, Client-Secret und Grant Type in der von Ihrem Unternehmen verwendeten Sprache und dem entsprechenden Framework an.


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

 

Wenn die Anfrage gültig ist und der Client korrekt konfiguriert wurde, erhalten Sie eine JSON-Antwort:

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

 

Siehe Artikel: How to - Authenticate

Verwandte Beiträge