Tutorial: Testen von API-Endpunkten für Vertriebspartner
Verwenden Sie die Sandbox, um Testanrufe zu tätigen, ohne die Produktionsdaten zu beeinträchtigen.
Die Vertriebspartner-API (SP-API) bietet Sandbox-Umgebungen wo Sie die SP-API-Endpunkte testen können, ohne die Produktionsdaten zu beeinträchtigen. Sie können Aufrufe an die SP-API-Sandbox-Endpunkte weiterleiten, um statische Anfragen zu stellen, die Scheinantworten zurückgeben. Mithilfe der Sandbox können Sie die Schritte üben, die zum Tätigen eines Anrufs erforderlich sind, sich mit den Anforderungs- und Antwortformaten vertraut machen, die Validierung von Anmeldeinformationen für Anwendungen üben und mit API-Endpunkten spielen, ohne die Produktionsdaten zu beeinträchtigen.
Tutorial
Das folgende Tutorial zeigt, wie Sie die erforderlichen Zugriffstoken generieren und Aufrufe an die SP-API-Sandbox-Endpunkte tätigen.
Voraussetzungen
Um dieses Tutorial abzuschließen, benötigen Sie die folgenden Voraussetzungen:
- Ein Postman-Konto und ein Arbeitsbereich. Weitere Informationen zur Verwendung von Postman findest du unter Verwendung von Postman für den Verkauf von Partner-API-Modellen.
- Wenn Sie ein eigenes Vertriebspartnerkonto haben, können Sie selbst autorisieren Ihr Antrag auf Zugriff auf Ihre Kontoinformationen.
- Wenn Sie kein eigenes Vertriebspartnerkonto haben, müssen Sie ein Konto einrichten OAuth-Workflow von Drittanbietern. Mit diesem Workflow können Drittanbieter und Anbieter Ihren Antrag autorisieren, auf ihre Amazon-Verkaufspartnerdaten zuzugreifen.
Während dieses Vorgangs erhalten Sie ein Aktualisierungstoken, das Sie später gegen ein Zugriffstoken eintauschen können. Ein Zugriffstoken ist erforderlich, um SP-API-Endpunkte aufzurufen.
Variablen, die für die Durchführung von Tests mit Postman benötigt werden
Um mit Postman telefonieren zu können, müssen Sie zunächst die Anmeldeinformationen einrichten. Sie benötigen die folgenden globalen Variablen für Ihren Workspace:
client_id
: Sie benötigen die client_id, um ein LWA-Zugriffstoken anzufordern. Die client_id wird hinter Ihnen angezeigt registriere deine App. Informationen zum Abrufen dieses Werts finden Sie unter Ihre Entwicklerinformationen anzeigen.client_secret
: Sie benötigen das client_secret, um ein LWA-Zugriffstoken anzufordern. Das client_secret erscheint hinter Ihnen registriere deine App. Informationen zum Abrufen dieses Werts finden Sie unter Ihre Entwicklerinformationen anzeigen.refresh_token
: Das LWA-Aktualisierungstoken. Holen Sie sich diesen Wert, wenn der Vertriebspartner Ihren Antrag autorisiert. Wenn Sie über ein eigenes Verkaufspartnerkonto verfügen, können Sie Ihren Antrag selbst autorisieren, um das Aktualisierungstoken zu erhalten. Weitere Informationen finden Sie unter Autorisierung von API-Anwendungen für Vertriebspartner.base_url_sandbox
: Informationen zum Abrufen der Sandbox-Endpunkte der Vertriebspartner-API für jede Region finden Sie unter SP-API-Sandbox-Endpunkte.
Schrittweiser Arbeitsablauf
Sie können die folgenden Schritte verwenden, um einen Verkaufspartner-API-Endpunkt zu testen:
Schritt 1. Generieren Sie ein Zugriffstoken für die Anmeldung mit Amazon (LWA)
Zunächst müssen Sie Ihren Antrag autorisieren, um im Namen eines Vertriebspartners auf Verkaufsdaten zuzugreifen. Wenn Sie ein Zugriffstoken für die Anmeldung mit Amazon (LWA) generieren, kann es für mehrere SP-API-Aufrufe verwendet werden, bis es abläuft.
Eine ausführliche Anleitung finden Sie unter Generieren Sie ein LWA-Zugriffstoken mit Postman oder Schritt 1. Fordern Sie eine Anmeldung mit dem Amazon-Zugriffstoken an.
Die Antwort gibt eine LWA-Zugriffstoken das du verwenden kannst, um deinen SP-API-Aufruf zu authentifizieren. Ein LWA-Zugriffstoken muss in Aufrufen aller Operationen (außer eingeschränkten Vorgängen) enthalten sein, die personenbezogene Daten (PII) zurückgeben. Wenn Sie eingeschränkte Operationen aufrufen, fügen Sie ein Restricted Access Token (RDT) anstelle eines LWA-Zugriffstokens ein
Die folgende Abbildung zeigt ein Beispiel, an dem das Zugriffstoken beginnt Atza|****************************
und läuft in 3600 Sekunden (1 Stunde) ab (die Anzahl der Sekunden, bevor das LWA-Zugriffstoken ungültig wird).

Anfrage und Antwort auf LWA-Zugriffstoken
Schritt 2. Rufen Sie den SP-API-Sandbox-Endpunkt auf
In den folgenden Schritten wird das Ausführen eines Aufrufs an den SP-API-Sandbox-Endpunkt mithilfe des Orders API-Swagger-Modells geübt. Sie können diesen Prozess verwenden, um API-Aufrufe zu testen und Scheinanfragen und -antworten zu untersuchen.
- Importiere die API für Bestellungen Swagger-Modell für Ihren Postman-Arbeitsbereich.
- Suchen Sie den Code nach einem
x-amzn-api-sandbox
Objekt, das ein statisches Array von Anforderungs- und Antwortbeispielen für statische Sandbox-Aufrufe an den API-Vorgang enthält, in dem sie vorkommen. - Stellen Sie die Anforderungsparameter mit denselben Werten ein, die das Orders API-Swagger-Modell definiert.
- Vergewissern Sie sich, dass Ihre Anfrage alle erforderlichen Parameter enthält, wie sie im entsprechenden Swagger-Modell definiert sind. Das folgende Beispiel zeigt eine API v0 bestellen Swagger-Modell, wo
Get Order
Der API-Aufruf wird mit einer erfolgreichen Antwort hervorgehoben:

Bestellungen API v0 Swagger-Modell
- Mache eine
GET
Rufen Sie an/orders/v0/orders
. - Stellen Sie das
baseUrl
als API-Sandbox für Vertriebspartner. - Unter dem Parameter Tab, übergeben Sie die statischen Anforderungswerte aus dem Orders API-Modell.

Statische Anforderungswerte auf der Registerkarte Parameter
- Unter dem Überschriften Tab, übergebe den
access_token
erhalten in Schritt 1 für jeden API-Aufruf unter Verwendung des Schlüssel-Wert-Paaresx-amz-access-token
:Atc|********************
. Überspringen Sie diesen Schritt für eingeschränkter Betrieb und Operationen ohne Zuschüsse.

Zugriffstoken auf der Registerkarte „Header“
- Für eingeschränkter Betrieb, übergeben Sie das Restricted Data Token (RDT), das Sie von der erhalten haben
createRestrictedDataToken
Operationen unter Verwendung des Schlüssel-Wert-Paaresx-amz-access-token
:Atz.sprdt|********************
.
Wichtig
Wenn Sie einen eingeschränkten Vorgang aufrufen, um auf die personenbezogenen Daten (PII) eines Kunden zuzugreifen, z. B. Käuferinformationen oder eine Lieferadresse, geben Sie eine Eingeschränktes Datentoken (RDT) in den Anforderungsheadern statt einer LWA-Zugriffstoken. Du kannst den anrufen Erstellen Sie ein Token mit eingeschränkten Daten Betrieb in Token-API um eine zu bekommen Eingeschränktes Datentoken (RDT) für eine oder mehrere eingeschränkte Ressourcen, die Sie angeben.
Die folgende Beispielantwort gibt einen RDT und seine Ablaufzeit zurück. Das RDT-Token kann im verwendet werden Get Orders
Vorgang zum Abrufen von PII-Daten.

Eingeschränkte Antwort- und Ablaufzeit des Datentokens
{ "restrictedDataToken": "Atz.sprdt|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSR", "expiresIn": 3600 }
- Überprüfen Sie, ob die Antwort eine Nutzlast zurückgibt, die dem Swagger-Modell entspricht.

Statische Antwort der Orders v0 API mithilfe des Zugriffstoken abrufen
Verwenden Sie die dynamische Sandbox der Vertriebspartner-API, um statusbehaftete Anfragen zu stellen
Die SP-API bietet auch eine dynamische Sandbox wo Sie Anfragen stellen und verschiedene Antworten erhalten können, die potenziell statusbehaftet sind und auf Eingaben reagieren.
Sie können feststellen, welche Vorgänge dynamische Sandbox-Aufrufe unterstützen, indem Sie die JSON des Swagger-Modells für die API überprüfen, die Sie aufrufen möchten. Ein Vorgang unterstützt Aufrufe der dynamischen Sandbox, wenn der Vorgang das folgende Objekt enthält:
"x-amzn-api-sandbox": { "dynamic": {} }
Das Objekt kann entweder auf Operations- oder Pfadebene gefunden werden. Auf Pfadebene können alle Operationen innerhalb des Pfads Aufrufe an die dynamische Sandbox senden.
Weitere Informationen zum Tätigen von Aufrufen an die dynamische Sandbox finden Sie unter Wie führe ich einen dynamischen Sandbox-Aufruf an die Verkaufspartner-API durch.
Fazit
In diesem Tutorial haben Sie gelernt, wie Sie Ihre SP-API-Sandbox-Endpunkte testen. In der exemplarischen Vorgehensweise haben Sie ein LWA-Zugriffstoken generiert und Beispiele für SP-API-Aufrufe an die Sandbox-Endpunkte untersucht.
Updated 8 months ago