Selling Partner APIモデルでのPostmanの使用

Selling Partner APIモデルでのPostmanの使用

このドキュメントでは、Selling Partner API(SP-API)モデル用に{{0}}をセットアップして使用する方法について説明します。{{1}}を使用して、Amazonアカウントでログイン(LWA)アクセストークンを生成し、SP-APIモデルをインポートして、SP-APIエンドポイントへの呼び出しを行い、SP-APIサンドボックスエンドポイントへの呼び出しを行うことができます。

呼び出しを行うために必要な認証情報

Postman を使用してログイン・ウィズ・アマゾン (LWA) アクセストークンを生成する

Amazonアカウントでログイン(LWA)を使用すると、Amazon購入者は、Amazonのユーザー名とパスワードを使用して、登録済みのサードパーティウェブサイトまたはモバイルアプリ(「クライアント」)にログインできます。クライアントは、名前、メールアドレス、郵便番号など、Amazonプロフィールにある個人情報を共有するよう購入者に求めることがあります。SP-APIモデルで{{0}}を使用するには、その前にまずSP-APIに認証するためのアクセストークンを生成する必要があります。

  1. [開く] 郵便配達員 そして、アカウントにログインします。

  2. にとって Workspaces、ワークスペースを選択してください。

  3. Newを選択します。

  4. Create New ダイアログボックス、選択 HTTP Request

    The Create New Window, which shows the HTTP Request as the first item to choose from.

  5. にとって Request、選択してください POST

    The Request dropdown menu with POST selected.

  6. 次のリンクをコピーしてテキストボックスに貼り付けます。

    https://api.amazon.com/auth/o2/token

    the link pasted into the request field.

  7. 選択してください Authorization タブとフォー Type、選択してください No Auth

    The Type dropdown menu with No Auth selected.

  8. 選択してください Body タブをクリックして選択 x-www-form-urlencoded

    The Body tab selected and x-www-form-urlencoded selected.

  9. の中に Body 表、以下のキーと値のペアを追加してください。

    キーValue
    grant_typerefresh_token
    refresh_token[リフレッシュトークンの値]
    client_id[クライアントIDの値]
    client_secret[クライアントシークレットの値]

    The key-value pairs from the table entered into the table on the Body tab.

  10. Sendを選択します。

レスポンスにより、SP-APIへの認証に使用するアクセストークンが返されます。

"access_token": "Atza|*****", "refresh_token": "Atzr|*****"' "token_type": "bearer", "expires_in": 3600

SP-APIモデルをPostmanにインポートする

SP-APIエンドポイントを呼び出す前に、SP-APIモデルを{{0}}にインポートする必要があります。

  1. GitHub上のselling-partner-api-modelsフォルダを開きます。

  2. フォルダのリストで、ダウンロードするAPIモデルを見つけて選択し、JSONファイルを選択します。

  3. JSON ファイルビューで、 Raw ソースコードを表示するか、ダウンロードアイコンを選択して RAW ファイルをダウンロードします。

  4. モデルのソースコードをコピーします。

  5. テキストエディター(メモ帳など)を開き、モデルテキストを貼り付けます。次に、ファイルに「.json」拡張子を付けて保存します。

  6. 郵便配達員にサインインします。

  7. にとって Workspaces、ワークスペースを選択してください。

  8. 選択 Import、JSON ファイルを選択して選択してください Open

  9. Import ダイアログボックス、選択 Postman Collection そして選んで Import

    The Choose how to import your API pop-up page. The Postman Collection option is chosen and has a red box surrounding it. The Import button on the bottom right of the page is also surrounded by a red box.

ファイルが正常にインポートされると、成功メッセージが表示されます。

A success message stating that 1 out of 1 element was imported and the name of the collection Selling Partner API for Sellers.

SP-APIエンドポイントを呼び出す

  1. 郵便配達員にサインインします。

  2. にとって Workspaces、ワークスペースを選択してください。

  3. Collections タブをクリックし、新しくインポートした API を選択し、 GET オペレーション。

  4. まだお持ちでない場合は、Postmanを使用してLWAアクセストークンを生成します。リフレッシュトークンを生成するLWAアクセストークンが必要になります。

  5. Headers タブをクリックし、次のキーペアを追加します。

    キーValue
    x-amz-access-token[アクセストークン値]

    The On the Headers tab, when the x-amz-access-token Key is highlighted and the Value is entered with sample text.

  6. Sendを選択します。

応答テキストは次の場所に入力されます。 Response ウィンドウ。

SP-APIサンドボックスエンドポイントを呼び出す

Selling Partner APIサンドボックスへの呼び出しを行うプロセスは、 Selling Partner APIサンドボックスエンドポイントへの呼び出しを指示する以外は実稼働呼び出しを行う場合と同じです。Selling Partner APIでは、実稼働データに影響を与えたり、実際のイベントを発生させたりすることなく、アプリケーションをテストできる2つのサンドボックス環境が提供されます。

Selling Partner APIの静的サンドボックスは、パターンマッチングを使用して静的な模擬レスポンスを返します。Selling Partner APIの動的サンドボックスは、リクエストパラメーターに基づいて現実的なレスポンスを返すことができるサンドボックスバックエンドにリクエストをルーティングします。

詳細については、Selling Partner APIサンドボックスを参照してください。

  1. 郵便配達員にサインインします。

  2. 使用しているAPIのSwaggerモデルをhttps://github.com/amzn/selling-partner-api-models/blob/main/models/orders-api-model/ordersV0.jsonワークスペースにインポートします。たとえば、注文API Swaggerモデルです。

  3. にとって Workspaces、ワークスペースを選択してください。

  4. Collections タブをクリックし、コレクションを選択して GET オペレーション。たとえば、GET Orders API 呼び出しをテストする場合は、以下を選択します。 get Orders API コール。

  5. {{baseUrl}}Selling Partner APIサンドボックスとして設定します。

  6. Paramsタブで、Swaggerモデルからの静的リクエスト値を渡します。たとえば、注文APIです。

    The Params tab, which has the CreatedAfter and Markdetplaceids Keys.

  7. サンドボックスエンドポイントを呼び出すときは、対応するSwaggerモデルで定義されている必須パラメーターがすべてリクエストに含まれていることを確認する必要があります。注文API v0 Swaggerモデルの次の例を参照してください。ここでは、成功したレスポンスで注文の取得API呼び出しが強調表示されています。

    The Get Order API call, which has a successful response.

  8. まだお持ちでない場合は、Postmanを使用してLWAアクセストークンを生成します。リフレッシュトークンの生成にLWAアクセストークンが必要になります。

  9. Headers タブをクリックし、次のキーペアを追加します。

    キーValue
    x-amz-access-token[アクセストークン値]

    The On the Headers tab, when the x-amz-access-token Key is highlighted and the Value is entered with sample text.

  10. Sendを選択します。

  11. レスポンスで、Swaggerモデルと一致するペイロードが返されることを確認します。

    応答テキストは次の場所に入力されます。 Response ウィンドウ。

    The Sandbox response example, which shows the returned order information.


このページは役に立ちましたか?