Die nShift Checkout API ist ein Integrationsservice für die Kommunikation zwischen nShift Checkout und Ihrem Webshop. Die nShift Checkout API verwendet ein REST API-Framework zur Kommunikation mit JSON als Datenträger und bietet mehrere Funktionen.
Um mit der Nutzung der API zu beginnen, folgen Sie den untenstehenden Schritten oder springen Sie direkt zur technischen Dokumentation hier.
- Client ID und Secret erstellen
- Ein Token anfordern
- Eine Session erstellen
- Den Endpoint für Versandoptionen aufrufen
- Eine Teilsendung erstellen
- API-Dokumentation
1. Client ID und Secret erstellen
Beginnen Sie mit der Erstellung der Client ID und des Secrets, die für die Authentifizierung benötigt werden.
- Melden Sie sich mit Ihrem Eigentümer-Benutzer bei nShift Portal an.
- Klicken Sie oben links auf Settings und navigieren Sie zu API Configuration > Client.
- Klicken Sie auf der Seite Clients auf die Schaltfläche Add.
- Füllen Sie Display name und Description aus. Wählen Sie einen Namen und eine Beschreibung, mit denen Sie das Token später leicht identifizieren können. Aktivieren Sie das Kontrollkästchen Enable, um das Token sofort zu aktivieren. (Sie können das Token später jederzeit aktivieren oder deaktivieren).
- Wählen Sie unter Allowed Scopes die Option Public checkout API aus. Dies sind die APIs, auf die Sie Zugriff benötigen.
- Klicken Sie auf Save. Ihre Client ID und Ihr Client Secret werden nun generiert und auf dem Bildschirm angezeigt. Wichtig: Das Client Secret ist nach dem Schließen des Pop-ups nicht mehr verfügbar. Stellen Sie daher sicher, dass Sie es kopieren.
- Klicken Sie auf Close. Die Client ID wird nun auf der Seite Clients angezeigt. Sie können jederzeit auf eine Client ID klicken, um sie zu bearbeiten oder zu löschen oder sie zu aktivieren/deaktivieren.
2. Ein Token anfordern
Verwenden Sie Ihre Client ID und Ihr Client Secret, um ein Zugriffstoken zu generieren. Dies geschieht durch das Senden einer POST-Anfrage an den folgenden Endpoint:
https://account.nshiftportal.com/idp/connect/token
Beispiel:
POST https://account.nshiftportal.com/idp/connect/token
Cache-Control: no-cache
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-Response:
{
"access_token": "some-real-token-data-dskjfhsuijkdhfgjkasjdgfhqoeiefoiknsoidfgvoiltgjvpdrofjmwpkldujrftvoifgkhbnilsakjprotglijkqp2owrlfjkvmowrifgho2qw9ouejifpe9rodtuj3-0porfij9odtujgw0etioyh",
"expires_in": 3600,
"token_type": "Bearer"
}Das Bearer-Token ist eine Stunde gültig.
3. Eine Session erstellen
Verwenden Sie das Bearer-Token, um den Session-Endpoint von nShift Checkout aufzurufen. Senden Sie eine POST-Anfrage an:
https://www.nshiftportal.com/checkout/options/v1/sessions/{checkoutConnectionId}
Verwenden Sie die Connection ID als Path-Parameter. Gehen Sie im oberen Menü zu Connections und suchen Sie Ihre Connection ID in der Liste. (Lesen Sie mehr über Connections hier).
Der POST-Aufruf erstellt eine Session, die 4 Stunden gültig ist, sofern sie in diesem Zeitraum nicht verwendet wird. Die Session enthält Informationen aus Ihrer Checkout-Konfiguration, zum Beispiel Absenderinformationen. Wenn Sie ändern möchten, welche Checkout-Konfiguration Sie zum Abrufen von Versandoptionen verwenden, können Sie einfach ändern, auf welche Konfiguration die Connection ID verweist.
Um zu ändern, auf welche Checkout-Konfiguration eine Connection ID verweist, gehen Sie im oberen Menü zu Connections und klicken Sie auf die Connection, die Sie ändern möchten. Wählen Sie im Dropdown-Menü Configuration eine andere Checkout-Konfiguration aus und klicken Sie auf Save.
4. Den Endpoint für Versandoptionen aufrufen
Mithilfe der Session ID können Sie einen POST-Aufruf an den Endpoint für Versandoptionen senden:
https://www.nshiftportal.com/checkout/options/v1/shipping-options/{sessionId}
Der Request Body für den Endpoint der Versandoptionen enthält Informationen über den Empfänger, das Paket/die Pakete und weitere zusätzliche Daten, die die verfügbaren Versandoptionen beeinflussen können. Die Response enthält eine Liste verfügbarer Versandoptionen. Wenn Sie das nShift Checkout Widget verwenden, müssen diese Daten an die entsprechende Methode übergeben werden, um die Versandoptionen anzuzeigen.
5. Eine Teilsendung erstellen
Nachdem Ihr Endkunde eine Versandoption ausgewählt hat, können Sie eine Teilsendung in Ihrer Book and Print-Plattform (nShift Delivery, nShift Ship oder nShift Transsmart) erstellen.
Senden Sie einen POST-Aufruf an:
https://www.nshiftportal.com/checkout/shipments/v1/shipments
Weitere Informationen finden Sie in der API-Dokumentation.
Der Request Body dieses Aufrufs enthält die Session ID, die ausgewählte Versandoptions-ID und weitere Informationen zur Sendung, wie z. B. die Order ID, die als eindeutige Kennung dient, um die Teilsendung in der Book and Print-Plattform zu finden. Der Request Body enthält außerdem Informationen über den Empfänger. Einige Empfängerinformationen können geändert werden (einige Werte wie die Postleitzahl können aufgrund ihres Einflusses auf verfügbare Versandoptionen nicht geändert werden).
Der Aufruf führt zur Erstellung einer Teilsendung in der Book and Print-Plattform für die ausgewählte Versandoption. Um die Teilsendung in eine tatsächliche Sendung umzuwandeln, müssen die entsprechenden Endpoints in den jeweiligen Book and Print-Plattformen aufgerufen werden.
API-Dokumentation
Unsere technische API-Dokumentation finden Sie hier: