Selling Partner API 開発者ガイド (for Vendors)
目次
Selling Partner APIとは何ですか?
Selling Partner APIは、RESTベースのAPIです。ベンダーはプログラムでデータにアクセスしやすくなり、効率性を高め、必要労働量を削減し、顧客への応答時間を短縮することで、ビジネスの自動化に役立ちます。
Selling Partner APIエンドポイント
Selling Partner APIエンドポイントは、特定のAWSリージョンと関連付けられています。AWSリージョンは、Selling Partner APIをリクエストするときに署名の計算に必要な認証情報スコープの一部であるため、重要です。認証情報スコープを参照してください。
Selling Partner APIエンドポイント
地域 | エンドポイント | AWSリージョン |
---|---|---|
北米(カナダ、米国、メキシコ、ブラジルのマーケットプレイス) | https://sellingpartnerapi-na.amazon.com | us-east-1 |
ヨーロッパ(スペイン、イギリス、フランス、ドイツ、イタリア、トルコ、アラブ首長国連邦、インドのマーケットプレイス) | https://sellingpartnerapi-eu.amazon.com | eu-west-1 |
アジアパシフィック(シンガポール、オーストラリア、日本のマーケットプレイス) | https://sellingpartnerapi-fe.amazon.com | us-west-2 |
ベンダーグループについて
Selling Partner APIアプリケーションにデータへのアクセスを許可すると、ベンダーセントラルアカウントのサインイン認証情報に関連付けられたベンダーグループに、アクセス権を与えることになります。これはさらに、そのベンダーグループ内のすべてのベンダーコードにアクセス権を与えることになります。したがって、Selling Partner APIの統合には、ベンダーセントラルの適切な資格情報とベンダーグループを使用することが重要です。
単独ベンダーグループの使用
単独のベンダーグループを使用してベンダーコードをすべて管理すると、アプリケーションにそのベンダーグループのデータへのアクセスを許可できます。そのためには、そのベンダーグループに関連付けられたベンダーセントラルアカウントの認証情報を使用して、開発者として登録します。
ベンダーグループに、アプリケーションがアクセスするすべてのベンダーコードが含まれるように、ベンダーグループのベンダーコードを確認します。必要な場合、ベンダーグループのベンダーコードの追加や削除は、いつでも可能です。
ベンダーグループのベンダーコードを確認するには
-
ご利用マーケットプレイスのベンダーセントラルにアクセスします。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。
-
アプリケーションがアクセスするベンダーグループで、ベンダーセントラルアカウントの認証情報を使用してサインインします。
-
設定メニューの連絡先をクリックします。
-
連絡先ページを確認して、アプリケーションがアクセスするベンダーコードが存在するかどうかを判断します。
ベンダーグループのベンダーコードを追加または削除するには
-
ご利用マーケットプレイスのベンダーセントラルにアクセスします。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。
-
ベンダーコードを追加または削除するベンダーグループで、ベンダーセントラルアカウントの認証情報を使用してサインインします。
-
ページの上部にあるサポートリンクをクリックします。
-
サポートページで、お問い合わせボタンをクリックします。
-
Amazonサポートへのお問い合わせページで、設定とアカウント管理をクリックし、アカウント設定を選択します。
-
設定とアカウント管理ボックスの下部にあるさらにサポートが必要な場合をクリックします。
-
指示に従って、Amazonサポートにお問い合わせください。
複数ベンダーグループの使用
複数のベンダーグループを使用してベンダーコードを管理する場合があります。その場合、Selling Partner APIの統合には、1) 必要なすべてのベンダーコードを含む新しいベンダーグループを作成するか、2) 既存のベンダーグループを選択して必要なベンダーコードを追加することをお勧めします。ベンダーグループのベンダーコードは、いつでも追加または削除できます。ただし、開発者として登録すると、その開発者に関連付けられたベンダーグループを変更することはできません。ビジネスごとに異なるAPI統合を維持することはできます。そのためには、アクセスするベンダーグループごとに開発者として個別に登録します。その後、登録した各開発者との個別のAPI統合を開発できます。
新しいベンダーグループを作成するには
-
ご利用マーケットプレイスのベンダーセントラルにアクセスします。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。
-
アプリケーションがアクセスするベンダーグループで、ベンダーセントラルアカウントの認証情報を使用してサインインします。
-
ページの上部にあるサポートリンクをクリックします。
-
サポートページで、お問い合わせボタンをクリックします。
-
Amazonサポートへのお問い合わせページで、設定とアカウント管理をクリックし、アカウント設定を選択します。
-
設定とアカウント管理ボックスの下部にあるさらにサポートが必要な場合をクリックします。
-
指示に従って、Amazonサポートにお問い合わせください。
開発者として登録
Selling Partner APIアプリケーションを登録する前に、Selling Partner API開発者として登録する必要があります。
開発者として登録するには
-
開発者アカウントに関連付ける認証情報を使用して、ご利用マーケットプレイスのベンダーセントラルにサインインします。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。
-
統合メニューのAPI統合をクリックします。
デベロッパーセントラルページが表示されます。
-
開発者プロファイルに進むをクリックします。
開発者プロファイルページが表示されます。
-
指示に従って開発者として登録します。
または
-
ご利用マーケットプレイスの開発者プロファイルページに直接アクセスして、サインインします。たとえば、日本のマーケットプレイスの場合はhttps://vendorcentral.amazon.co.jp/developer/registerにアクセスします。
開発者プロファイルページが表示されます。
注: 上記の開発者プロファイルページへのリンクは、日本のマーケットプレイス用です。他の地域のURLは、そのマーケットプレイスのベンダーセントラルのベースURLに、
/developer/register
を付けます。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。たとえば、イギリスのマーケットプレイスの場合、ベンダーセントラルのベースURLは
https://vendorcentral.amazon.co.uk
なので、開発者プロファイルページのURLはhttps://vendorcentral.amazon.co.uk/developer/register
となります。 -
指示に従って開発者として登録します。
開発者プロファイル申請のステータスを確認するには
開発者プロファイル申請を送信すると、Amazonは提供された情報を評価し、その申請を承認または拒否します。却下された場合は、却下理由に対処した後、プロファイルを再送信できます。審査中の開発者プロファイル申請のステータスを確認するには
-
開発者プロファイルの作成時に使用した認証情報を使用して、ベンダーセントラルにサインインします。
-
統合メニューのAPI統合をクリックします。
デベロッパーセントラルページが表示されます。
-
開発者登録は審査中ですバナーの手順に従います。このバナーは、申請のステータスを反映して変わります。
開発者として登録されると、Selling Partner APIアプリケーションを登録できます。アプリケーション情報を表示するには、アプリケーション情報の表示を参照してください。
Selling Partner APIアプリケーションの登録
以下の手順では、アプリケーションの登録時に提供するIAMロールの作成を最終目的として、IAMポリシーとエンティティを作成して設定する方法について説明します。このワークフローでは、Selling Partner APIをコールする権限があるIAMロールを作成し、そのロールを保持するIAMユーザー(AWS STSポリシーがアタッチされている)を作成します。
開発者として登録し、Selling Partner APIのアプリケーションを登録する手順を以下に示します。
ステップ5.IAMユーザーにAWSセキュリティトークンサービスポリシーを追加する
ステップ1.AWSアカウントを作成する
Selling Partner APIセキュリティモデルではAWS認証情報を使用するため、AWSアカウントが必要です。まだAWSアカウントをお持ちではない場合、無料のAWSアカウントの作成はについて、AWS無料利用枠にて詳細を参照してください。IAMはAPIを使用するために必要な唯一のAWS機能で、お客様のAWSアカウントへの追加料金なしで提供されます。
ステップ2.IAMユーザーを作成する
IAMユーザーを作成して、Selling Partner APIのコールを認証するためのAWSキーを取得します。新たに専用のIAMユーザーを作成することをお勧めします。IAMユーザーを使用して、ステップ4.IAMロールを作成するで作成したIAMロールを継承します。
登録時に、IAMユーザーがSelling Partner APIアプリケーションに関連付けられます。
IAMユーザーを作成するには
-
まだサインインしていない場合は、AWS管理コンソールにサインインし、https://console.aws.amazon.com/iamでIAMコンソールを開きます。
-
左側のナビゲーションペインで、ユーザーをクリックし、ユーザーを追加をクリックします。
-
新しいユーザーのユーザー名を入力します。これはAWSのサインイン名となります。
-
プログラムによるアクセスを選択し、次のステップ: アクセス許可をクリックします。
-
権限の設定ページで、デフォルトを受け入れ次のステップ: タグをクリックします。IAMロールを作成するときにアクセス許可を設定します。
-
**タグの追加(オプション)**ページでオプションのタグを追加し、次のステップ: 確認をクリックします。
-
確認ページで、選択した内容を確認します。このユーザーには権限がありませんという警告は無視できます。IAMロールを作成するときにアクセス許可を設定します。続行する準備ができたら、ユーザーの作成ボタンをクリックします。
新しいIAMユーザーのAWSアクセスキーIDが表示されます。
-
表示をクリックすると、AWS秘密キーが表示されます。AWSアクセスキーを保存するには、.csvのダウンロードをクリックし、ファイルを安全な場所に保存します。
重要: これは、AWS秘密アクセスキーを表示またはダウンロードする唯一の機会です。このキーは、Selling Partner APIのコールを認証する際に必要となります。AWSアクセスキーIDとAWS秘密キーを安全かつ安全な場所に保存します。**このステップの後でAWSアクセスキーに再度アクセスすることはできません。**AWS秘密アクセスキーを紛失した場合は、新しいキーセットを使用して新たにIAMユーザーを作成する必要があります。
-
閉じるをクリックします。
-
ユーザー名列で新しいIAMユーザーをクリックし、ユーザーARNを書き留めます。これはステップ4.IAMロールを作成するで必要となります。
詳細については、AWSドキュメントのAWSアカウントでのIAMユーザーの作成を参照してください。
ステップ3.IAMポリシーを作成する
このIAMポリシーは、Selling Partner APIをコールするためのアクセス権限を定義します。ステップ4.IAMロールを作成するで作成したIAMロールに適用します。
IAMポリシーを作成するには
-
AWS管理コンソールにサインインし、console.aws.amazon.com/iamでIAMコンソールを開きます。
-
左側のナビゲーションペインで、ポリシーをクリックします。
ポリシーを初めて選択する場合は、管理ポリシーにようこそページが表示されます。開始するをクリックします。
-
ポリシーの作成ボタンをクリックします。
-
JSONタブをクリックします。
-
テキストボックスに次のコードを貼り付け、既存のコードを置き換えて、ポリシーの確認をクリックします。
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "execute-api:Invoke", "Resource": "arn:aws:execute-api:*:*:*" } ] }
-
ポリシーの確認ページで、作成するポリシーの名前と説明(オプション)を入力します。IAMポリシーには
SellingPartnerAPI
という名前を付けることをお勧めします。 -
ポリシーの概要を確認して、ポリシーによって付与された権限を確認し、ポリシーの作成ボタンをクリックします。
新しいIAMポリシーがリストに表示されます。
詳細については、AWSドキュメントのIAMポリシーの作成を参照してください。
ステップ4.IAMロールを作成する
ステップ2.IAMユーザーを作成するで作成したIAMユーザーを信頼し、Selling Partner APIをコールする権限のあるIAMロールを作成します。
IAMロールを作成するには
-
まだサインインしていない場合は、AWS管理コンソールにサインインし、console.aws.amazon.com/iamでIAMコンソールを開きます。
-
左側のナビゲーションペインで、ロールをクリックし、ロールを作成ボタンをクリックします。
-
ロールを作成ページで、別のAWSアカウントをクリックします。
-
アカウントIDボックスに、ステップ2.IAMユーザーを作成するでIAMユーザーを作成したAWSアカウントのアカウントIDを入力し、次のステップ: アクセス許可ボタンをクリックします。
-
アクセス許可ポリシーの添付ページのポリシー名で、ステップ3.IAMポリシーを作成するで作成したポリシーを選択し、次のステップ: タグをクリックします。
ヒント:****フィルタポリシーをクリックし、カスタマー管理を選択して選択を絞り込みます。
-
**タグの追加(オプション)**ページで、必要に応じてオプションのタグを追加し、次のステップ: 確認ボタンをクリックします。
-
ロールを作成ページで、ロール名ボックスにロール名を入力し、ロールの説明ボックスにオプションのロールの説明を入力し、ロールを作成ボタンをクリックします。
-
ロール名で、新しいロールの名前をクリックします。
概要ページが表示されます。
-
ロールのARNを保存します。これは以下で必要となります。
詳細については、AWSドキュメントのIAMユーザーにアクセス権限を委任するロールの作成を参照してください。
ステップ5.IAMユーザーにAWSセキュリティトークンサービスポリシーを追加する
AWSセキュリティトークンサービス(AWS STS)ポリシーをIAMユーザーに追加すると、Selling Partner APIへのリクエストの認証に使用できる一時的なAWSアクセスキーをリクエストできます。これらの認証情報は、一定期間が経過すると期限切れになり、AWSリソースへのアクセスを制御するのに役立ちます。
-
まだサインインしていない場合は、AWS管理コンソールにサインインし、console.aws.amazon.com/iamでIAMコンソールを開きます。
-
左側のナビゲーションペインで、ユーザーをクリックし、AWS STSポリシーを追加するユーザーをクリックします。このワークフローでは、ステップ2.IAMユーザーを作成するで作成したユーザーを選択します。他のユースケースでは別のIAMユーザーを選択することもできます。
-
アクセス許可タブで、インラインポリシーの追加をクリックします。
-
ポリシーの作成ページで、サービスの選択をクリックします。
-
STSサービスをクリックします。
ヒント。検索ボックスにSTSと入力して、選択肢を絞り込みます。
-
書き込みの横にある矢印をクリックして展開します。
-
AssumeRoleを選択します。
-
リソースの横にある矢印をクリックして展開し、ARN****を追加をクリックします。
-
ARNを追加ダイアログボックスで、ステップ4.IAMロールを作成するのロールARNをロールのARNを指定ボックスに入力し、追加をクリックし、ポリシーの確認ボタンをクリックします。
-
ポリシーの確認ページで、名前ボックスにポリシーの名前を入力します。選択した内容を確認します。続行する準備ができたら、ポリシーの作成ボタンをクリックします。
ステップ6.アプリケーションを登録する
デベロッパーセントラルでアプリケーションを登録します。
アプリケーションを登録するには
-
開発者として登録に使用した認証情報を使用して、ベンダーセントラルにサインインします。
-
統合メニューのAPI統合をクリックします。
デベロッパーセントラルページが表示されます。
-
指示に従ってアプリケーションを登録します。
注: 開発者登録申請書(DRAF)にまだ入力していない場合は、申請を登録する前に、このフォームに入力するよう指示されます。ロールが付与されると、アプリケーションを登録できます。DRAFのケースIDを確認して、提出のステータスを追跡します。
重要: アプリケーションを登録する際、提供するIAM ARNは、ステップ3.IAMポリシーを作成するでIAMポリシーをアタッチしたIAMエンティティ用のものである必要があります。このワークフローで、そのIAMエンティティはステップ4.IAMロールを作成するのIAMロールです。IAMユーザーを使用してアプリケーションを登録する場合は、IAMポリシーがアタッチされていることを確認してください。アタッチされていないと、Selling Partner APIへのコールが失敗します。AWSリソースへのアクセスを適切に制御するために、このワークフローに示すようにIAMロールを使用してアプリケーションを登録することをお勧めします。
アプリケーション情報の表示
Selling Partner APIアプリケーションを登録すると、ベンダーセントラルのデベロッパーセントラルページでアプリケーション情報を表示できます。
アプリケーション情報を表示するには
-
ご利用マーケットプレイスのベンダーセントラルにアクセスします。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。
-
Selling Partner API開発者であることを識別するベンダーアカウントの認証情報を使用して、サインインします。詳細については、開発者としての登録を参照してください。
-
統合メニューのAPI統合をクリックします。
デベロッパーセントラルページが表示され、登録した各アプリケーションのアプリケーション名とIAMユーザーARNが表示されます。
-
Login with Amazon(LWA)の認証情報を表示するアプリケーションの表示リンクをクリックします。
LWA認証情報ボックスが表示され、アプリケーション認証用のLWAクライアント識別子が表示されます。
-
クライアントシークレットの横にある矢印をクリックして、アプリケーション認証用のLWAクライアントシークレットを表示します。
Selling Partner APIをコールする前に、LWAアクセストークンをリクエストするには、このLWA認証情報が必要になります。詳細については、ステップ1.Login with Amazonアクセストークンをリクエストするをご覧ください。
アプリケーションの認可
Selling Partner APIの認可モデルは、AmazonのOAuth 2.0実装であるLogin with Amazon(LWA)に基づくものです。開発者として登録し、Selling Partner APIアプリケーションを登録すると、アプリケーションによるSelling Partner APIのコールを許可して、ベンダーアカウント情報にアクセスできるようになります。ベンダーアカウント情報へのアクセスの詳細については、ベンダーグループについてを参照してください。
アプリケーションを認可するには
-
ご利用マーケットプレイスのベンダーセントラルにアクセスします。マーケットプレイス別のURL一覧については、ベンダーセントラルのURLを参照してください。
-
Selling Partner API開発者であることを識別するベンダーアカウントの認証情報を使用して、サインインします。詳細については、開発者としての登録を参照してください。
-
統合メニューのAPI統合をクリックします。
デベロッパーセントラルページが表示され、登録した各アプリケーションのアプリケーション名とIAMユーザーARNが表示されます。
-
認可するアプリケーションの横にあるアクション列で、アプリの編集の横にある下向き矢印をクリックしてから、認可をクリックします。
-
アプリケーションの認可ページで、リフレッシュトークンを生成ボタンをクリックします。
リフレッシュトークンがリフレッシュトークンボックスに表示されます。
注: そのリフレッシュトークンは保存する必要があります。ページを離れると、再び表示することはできません。
リフレッシュトークンは、短期間のアクセストークンと交換する長期間有効なトークンです。Selling Partner APIへのすべてのリクエストには、アクセストークンを含める必要があります。アクセストークンは発行から1時間有効です。有効期限が切れるまでは、複数のAPIコールで同じアクセストークンを使用できます。ステップ1.Login with Amazonアクセストークンをリクエストするをご覧ください。
LWAトークンの交換と認証を備えたJava SDKの生成
生成されるJava SDKで、Selling Partner APIオペレーションを簡単にコールすることができます。このSDKは、アクセストークンのLogin with Amazon(LWA)リフレッシュトークンを交換することで認可を処理し、AWS署名バージョン4を使用してリクエストに署名することで認証を処理します。
以下の手順では、Microsoft Windowsを実行しているコンピューターで、Swagger Code Generatorを使用してベンダー注文APIのJava SDKを生成する方法を説明します。このプロセスは、macOSやLinuxなどの他のオペレーティングシステムのユーザーも、Windows固有のセマンティクス(C:\
など)を置き換えることで応用できます。以下の手順はベンダー注文オペレーションに固有ですが、Selling Partner APIの任意のオペレーションに対してSDKを生成するようにこの手順を変更できます。そのためには、(vendorOrders.jsonではなく)任意のSwaggerファイルをディレクトリ構造にコピーします。次に、コード例を変更して、「vendrOrders.json」を、使用しているSwaggerファイルのファイル名に置き換えます。
前提条件
この手順を完了するには、以下が必要です。
-
vendorOrders.jsonこれは、SDKの生成に使用するSwaggerファイルです。
-
sellingpartner-api-aa-javaフォルダこのフォルダには、認可および認証ライブラリと、Swagger Code Generator用のカスタマイズされたテンプレートが含まれています。
これらのファイルは、当社が提供したSDKに(この開発者ガイドとともに)含まれています。
LWAトークンの交換と認証を備えたJava SDKを生成するには
-
Java 8以降、Apache Maven 3.6以降、GNU Wgetをインストールし、
$PATH
で利用できるようにします。 -
コマンドプロンプトウィンドウを開き、Swagger Code Generatorをダウンロードするディレクトリに移動します。
-
Swagger 2用Swagger Code Generatorの最新バージョンをダウンロードします。
例:
wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.13/swagger-codegen-cli-2.4.13.jar -O swagger-codegen-cli.jar
swagger-codegen-cli.jarが現在のディレクトリにダウンロードされます。
**注意:**また、ブラウザに以下のURLを指示することで、maven.orgからダウンロードすることもできます:https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.13/swagger-codegen-cli-2.4.13.jar
-
vendorOrders.jsonとswagger-codegen-cli.jarをディレクトリ構造にコピーすると、わかりやすくなります。この例では、
C:\SwaggerToCL
にコピーします。 -
sellingpartner-api-aa-javaフォルダ内のテンプレートに対してSDKを生成します。
例:
java -jar C:\\SwaggerToCL\\swagger-codegen-cli.jar generate -i C:\\SwaggerToCL\\vendorOrders.json -l java -t \[path to clients\\sellingpartner-api-aa-java directory\]/resources/swagger-codegen/templates/ -o C:\\SwaggerToCL\\vendorOrders_JavaCL
このSDKは、C:\SwaggerToCL\vendorOrders_JavaCLにコピーされます。
-
AA(認可と認証)ライブラリを構築し、SDKの依存関係として追加します:sellingpartner-api-aa-javaフォルダに移動し、
mvnパッケージ
を実行します。これにより、必要な依存関係をすべて含むディレクトリにJARファイルが生成されます。このフォルダーは、sellingpartnerapi-aa-java-1.0-jar-with-dependenciesのような名前にする必要があります。- JARファイルをローカルのMavenリポジトリにインストールします。例: ```bash mvn install:install-file -Dfile=\[path to JAR file in "target" folder\] -DgroupId=com.amazon.sellingpartnerapi -DartifactId=sellingpartnerapi-aa-java -Dversion=1.0 -Dpackaging=jar ``` 上記の例で<code>groupId</code>、<code>artifactId</code>、<code>version</code>の値は、**sellingpartner-api-aa-java**フォルダーの**pom.xml**ファイルの上部近くで使用します。 - クライアントライブラリのpom.xmlに、AAライブラリへの依存関係を追加します。 ```xml <dependency> <groupId>com.amazon.sellingpartnerapi</groupId> <artifactId>sellingpartnerapi-aa-java</artifactId> <version>1.0</version> </dependency> ```
SDKを生成したら、それを使用してSelling Partner APIをコールすることができます。生成されたJava SDKを使用したSelling Partner APIへの接続をご覧ください。
生成されたJava SDKを使用したSelling Partner APIへの接続
以下の手順では、生成されたJava SDKを使用してSelling Partner APIをコールする方法について説明します。SDKは、AWSとLWAの認証情報を設定するためのクラスを公開し、それを使用してLWAトークンを交換し、リクエストに署名します。
詳細については、認可と認証を使用したJava SDKの生成を参照してください。
または、「LWAトークンの交換と認証を備えたJava SDKの生成」を参照してください。
ステップ1.AWS認証情報の設定
以下のパラメーターを使用して、AWSAuthenticationCredentials
インスタンスを作成します。
名前 | 説明 | 必須 |
---|---|---|
accessKeyId | AWSのアクセスキーID。詳細については、ステップ2.IAMユーザーを作成するを参照してください。 | はい |
secretKey | AWSの秘密アクセスキー。詳細については、ステップ2.IAMユーザーを作成するを参照してください。 | はい |
region | コールを実行しているAWSリージョン。詳細については、Selling Partner APIエンドポイントを参照してください。 | はい |
例:
import com.amazon.SellingPartnerAPIAA.AWSAuthenticationCredentials; AWSAuthenticationCredentials awsAuthenticationCredentials=AWSAuthenticationCredentials.builder() .accessKeyId("myAccessKeyId") .secretKey("mySecretId") .region("us-east-1") .build();
ステップ2.AWS認証情報プロバイダーの設定
以下のパラメーターを使用して、AWSAuthenticationCredentialsProvider
インスタンスを作成します。
名前 | 説明 | 必須 |
---|---|---|
roleArn | ステップ4.IAMロールを作成するで作成したIAMロールのARN。 | はい |
roleSessionName | 定義するセッションの識別子。ユニバーサルユニークID(UUID)を使用することをお勧めします。 | はい |
例:
import com.amazon.SellingPartnerAPIAA.AWSAuthenticationCredentials; AWSAuthenticationCredentialsProvider awsAuthenticationCredentialsProvider=AWSAuthenticationCredentialsProvider.builder() .roleArn("myroleARN") .roleSessionName("myrolesessioname") .build();
ステップ3.LWA認証情報の設定
以下のパラメーターを使用して、LWAAuthorizationCredentials
インスタンスを作成します。
名前 | 説明 | 必須 |
---|---|---|
clientId | LWAのクライアントID。詳細については、アプリケーション情報の表示を参照してください。 | はい |
clientSecret | LWAのクライアントシークレット。詳細については、アプリケーション情報の表示を参照してください。 | はい |
refreshToken | LWAのリフレッシュトークン。ベンダーがアプリケーションを認可したときにこの値を取得します。詳細については、アプリケーションの認可を参照してください。 | はい |
endpoint | LWA認証サーバーのURI。 | はい |
例:
import com.amazon.SellingPartnerAPIAA.LWAAuthorizationCredentials; ... LWAAuthorizationCredentials lwaAuthorizationCredentials = LWAAuthorizationCredentials.builder() .clientId("myClientId") .clientSecret("myClientSecret") .refreshToken("Aztr|...") .endpoint("https://api.amazon.com/auth/o2/token") .build();
ステップ4.Vendor Orders APIのインスタンスの作成と、オペレーションのコール
AWSAuthenticationCredentials
インスタンスとLWAAuthorizationCredentials
インスタンスを設定すると、vendorOrdersApi
インスタンスを作成してオペレーションをコールすることができます。
**注意:**これは、LWAトークンの交換と認証を備えたJava SDKの生成で生成された、ベンダー注文APIのSDKを使用する例です。別のAPIのSDKを生成した場合は、以下の例のvendorOrdersApi
をそのAPIに一致するテキストに置き換えます。たとえば、ベンダー出荷APIに生成されたSDKには、vendorShippingAPI
を使用します。
例:
vendorOrdersApi vendorOrdersApi = new vendorOrdersApi.Builder() .awsAuthenticationCredentials(awsAuthenticationCredentials) .lwaAuthorizationCredentials(lwaAuthorizationCredentials) .endpoint("https://sellingpartnerapi-na.amazon.com") .build(); vendorOrdersApi.getMarketplaceParticipations();
Javaクライアントライブラリの生成
生成されたJavaクライアントライブラリは、URIを構築してリクエストを行うためのヘッダーを追加するのに役立ちますが、リクエストの認可と認証には役立ちません。それでも、Login with Amazonアクセストークンをリクエストして、リクエストの作成と署名を行う必要があります。
**注意:**ほとんどのJava開発者にとって、Selling Partner APIに接続する最も簡単な方法は、生成された、認証と認可が含まれるJava SDKを使用することです。詳細については、LWAトークンの交換と認証を備えたJava SDKの生成を参照してください。
以下の手順では、Microsoft Windowsを実行しているコンピューターで、Swagger Code Generatorを使用してベンダー注文APIのJavaクライアントライブラリを生成する方法を説明します。このプロセスは、macOSやLinuxなどの他のオペレーティングシステムのユーザーでも、Windows固有のセマンティクス(C:\など)を置き換えることで応用できます。以下の手順はベンダー注文オペレーションに固有ですが、これを変更して、Selling Partner APIの任意のオペレーションにクライアントライブラリを生成できます。そのためには、(vendorOrders.jsonではなく)任意のSwaggerファイルをディレクトリ構造にコピーします。次に、コード例を変更して、「vendrOrders.json」を、使用しているSwaggerファイルのファイル名に置き換えます。
前提条件
この手順を完了するには、以下が必要です。
- vendorOrders.jsonこれは、SDKの生成に使用するSwaggerファイルです。
Javaクライアントライブラリを生成するには
-
Java 8以降、Apache Maven 3.6以降、wgetをインストールし、$PATHで利用できるようにします。
-
まだ実行していない場合は、リポジトリをクローンしてコンピュータにローカルコピーを作成します。
-
コマンドプロンプトウィンドウを開き、Swagger Code Generatorをダウンロードするディレクトリに移動します。
-
Swagger 2用Swagger Code Generatorの最新バージョンをダウンロードします。
例:
wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.7/swagger-codegen-cli-2.4.7.jar -O swagger-codegencli.jar
swagger-codegen-cli.jarが現在のディレクトリにダウンロードされます。
注また、ブラウザに以下のURLを指定することで、maven.orgからダウンロードすることもできます。http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.7/swagger-codegen-cli-2.4.7.jar
-
vendorOrders.jsonとswagger-codegen-cli.jarをディレクトリ構造にコピーすると、わかりやすくなります。この例では、C:\SwaggerToCLにコピーします。
-
クライアントライブラリを生成します。
例:
java -jar C:\\SwaggerToCL\\swagger-codegen-cli.jar generate -i C:\\SwaggerToCL\\vendorOrders.json -l java -o C:\\SwaggerToCL\\vendorOrders.json_JavaCL
クライアントライブラリが、C:\SwaggerToCL\vendorOrders_JavaCLにコピーされます。
Selling Partner APIへの接続
以下で、Selling Partner APIをコールする手順を説明します。この手順は、主にJava以外の言語でコーディングする開発者向けです。Javaでコーディングする開発者には、生成されたJava SDKを使用することをお勧めします。リクエストの作成に役立ち、認可と認証がはるかに簡単になります。詳細については、LWAトークンの交換と認証を備えたJava SDKの生成をご覧ください。
開発者のアプリケーションをSelling Partner APIに接続するには、アプリケーションを登録し、登録したアプリケーションをベンダー/パートナーが認可する必要があります。Selling Partner APIアプリケーションの登録とアプリケーションの認可を参照してください。
ステップ1.Login with Amazonアクセストークンをリクエストする
Login with Amazon(LWA)アクセストークンにより、開発者のアプリケーションがベンダー/パートナーの代わりに特定のアクションを実行することが認可されます。アクセストークンは発行後1時間で失効します。また、Selling Partner APIへのすべてのリクエストに含める必要があります。
アクセストークンをリクエストするには、以下のパラメーターを使用して、LWA認証サーバー(https://api.amazon.com/auth/o2/token)に安全なHTTP POSTを実行します。
名前 | 説明 | 必須 |
---|---|---|
grant_type | 要求されるアクセス許可のタイプ。refresh_tokenである必要があります。 | はい |
refresh_token | アプリケーションのベンダーアカウントへのアクセスを認可するには、この値を取得します。アプリケーションの認可を参照してください。 | はい |
client_id | アプリケーションを登録するときにこの値を取得します。アプリケーション情報の表示を参照してください。 | はい |
client_secret | アプリケーションを登録するときにこの値を取得します。アプリケーション情報の表示を参照してください。 | はい |
例:
POST /auth/o2/token HTTP/l.l Host: api.amazon.com Content-Type: application/x-www-form-urlencoded;charset=UTF-8 grant_type=refresh_token&refresh_token=Atzr\|IQEBLzAtAhRPpMJxdwVz2Nn6f2y-tpJX2DeX...&client_id=foodev&client_secret=Y76SDl2F
**ヒント:**LWA認可サーバーをコールするときに信頼されていない認証機関(CA)エラーが発生しないようにするには、アプリケーションがLWAサーバーを信頼するよう、証明書ストアを必ず更新してください。
cURL
必要に応じて、cURLを使用してアクセストークンをリクエストすることもできます。例:
curl -k -X POST -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=refresh_token& refresh_token=Atzr\|IQEBLzAtAhRPpMJxdwVz2Nn6f2y-tpJX2DeX...&client_id=foodev&client_secret=Y76SDl2F https://api.amazon.com/auth/O2/token
Response
成功レスポンスには、以下の値が含まれます。
名前 | 説明 |
---|---|
access_token | アクセストークン。最大サイズ: 2048バイト。 |
token_type | 返されるトークンのタイプ。ベアラーである必要があります。 |
expires_in | アクセストークンが無効になるまでの秒数。 |
refresh_token | リクエストで送信したリフレッシュトークン。最大サイズ: 2048バイト。 |
例:
HTTP/l.l 200 OK Content-Type: application/json;charset UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"Atza|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSREXAMPLE", "token_type":"bearer", "expires_in":3600, "refresh_token":"Atzr|IQEBLzAtAhRPpMJxdwVz2Nn6f2y-tpJX2DeXEXAMPLE" }
詳細については、Login with Amazonドキュメントの認証コードの付与ページを参照してください。
ステップ2.Selling Partner APIのURIを構築する
以下は、Selling Partner API URIのコンポーネントです。
名前 | 説明 | 例 |
---|---|---|
HTTPメソッド | HTTPメソッド。 | GET |
エンドポイント | Selling Partner APIエンドポイント。 | https://sellingpartnerapi-eu.amazon.com |
パス | Selling Partner APIセクション/リソースのセクション/バージョン番号。 | vendor/orders/v1/purchaseOrders |
クエリ文字列 | クエリパラメーター | ?limit={example}&createdAfter={example}&createdBefore={example}&sortOrder={example}&nextToken={example}&includeDetails={example} |
例:
GET https://sellingpartnerapi-eu.amazon.com/vendor/orders/v1/purchaseOrders?limit={example}&createdAfter={example}&createdBefore={example}&sortOrder={example}&nextToken={example}&includeDetails={example}
**注意:**Javaを使用してアプリケーションを作成する場合は、生成されたJavaクライアントライブラリを使用してURIを構築できます。詳細については、Javaクライアントライブラリの生成を参照してください 。
ステップ3.URIにヘッダーを追加する
ステップ2で作成したURIにヘッダーを追加します。Selling Partner APIのURIを作成します。
Selling Partner APIへのリクエストに含めるHTTPヘッダーは次のとおりです。
リクエストヘッダー
名前 | 説明 | 必須 |
---|---|---|
host | ベンダー/パートナーのエンドポイント。Selling Partner APIエンドポイントを参照してください。 | はい |
x-amz-access-token | Login with Amazonアクセストークン。ステップ1.Login with Amazonアクセストークンをリクエストするをご覧ください。 | はい |
x-amz-date | リクエストの日時。 | はい |
user-agent | アプリケーション名とバージョン番号、プラットフォーム、プログラミング言語。これらの情報は、サービスで発生する可能性のある問題を診断して解決する際に役立ちます。すべてのリクエストにUser-Agentヘッダーを含めるを参照してください。 | はい |
以下に、URIとヘッダーはあるが署名情報がないSelling Partner APIリクエストの例を示します。
GET https://sellingpartnerapi-eu.amazon.com/vendor/orders/v1/purchaseOrders?limit={example}&createdAfter={example}&createdBefore={example}&sortOrder={example}&nextToken={example}&includeDetails={example} HTTP/1.1 host: https://sellingpartnerapi-eu.amazon.com user-agent: My Selling Tool/2.0 (Language=Java/1.8.0.221; Platform=Windows/10) x-amz-access-token=Atza|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSREXAMPLE x-amz-date: 20190430T123600Z
**注意:**Javaを使用してアプリケーションを作成する場合は、生成されたJavaクライアントライブラリを使用して、URIにヘッダーを追加できます。詳細については、Javaクライアントライブラリの生成を参照してください 。
リクエストに署名するには、ステップ4.リクエストの作成と署名をご覧ください。
ステップ4.リクエストの作成と署名
Selling Partner APIでは、署名バージョン4署名プロセスを使用してリクエストを認証します。Selling Partner APIにHTTPリクエストを送信する際に、リクエストを送信したユーザーが識別されるよう、リクエストに署名します。アクセスキーIDと秘密キーで構成されるAWSアクセスキーを使用して、リクエストに署名します。AWSアクセスキーの取得については、ステップ3.IAMユーザーを作成するを参照してください。
注手動でHTTPリクエストを作成する場合に限り、HTTPリクエストの署名方法について学ぶ必要があります。いずれかのAWS SDKを使用して署名を計算すると、設定時に指定したアクセスキーを使用して、SDKによってリクエストに自動的に署名されます。SDKを使用する場合は、自分でリクエストに署名する方法を学ぶ必要がありません。たとえばJava開発者は、署名を計算するためのモデルとして、Java用AWS SDKのAWS4Signer.javaを使用できます。AWS GitHubリポジトリには、他の言語用のSDKも用意されています。
リクエストを作成して署名するには、次の操作を行います。
-
正規リクエストを作成する
AWSドキュメントのタスク1: 署名バージョン4の正規リクエストを作成するに従って、このガイダンスを使用します。
- ステップ3.URIにヘッダーを追加するをご覧ください。
- ハッシュアルゴリズムにはSHA-256を使用します。
- クエリパラメーターには認証情報を入れないでください。これはAuthorizationヘッダーパラメーターに含めてください。
-
署名する文字列を作成する
AWSドキュメントのタスク2: 署名バージョン4の署名文字列を作成するに従って、このガイダンスを使用します。
- アルゴリズムの指定値は、
AWS4-HMAC-SHA256
です。 - 認証情報スコープを決定するには、認証情報スコープをご覧ください。
- アルゴリズムの指定値は、
-
署名を計算する
AWSドキュメントのタスク3: AWS署名バージョン4の署名を計算するに従います。
-
署名情報を追加する
AWSドキュメントのタスク4: HTTPリクエストに署名を追加するに従って、このガイダンスを使用します。
- クエリ文字列には署名情報を追加しないでください。これはAuthorizationヘッダーに追加します。
- Authorizationヘッダー作成の詳細については、Authorizationヘッダーを参照してください。
次の例では、Authorizationヘッダーを使用して署名情報を追加した後で、リクエストがどのように表示されるかを示します。
GET https://sellingpartnerapi-eu.amazon.com/vendor/orders/v1/purchaseOrders?limit={example}&createdAfter={example}&createdBefore={example}&sortOrder={example}&nextToken={example}&includeDetails={example} HTTP/1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20190430/us-east- 1/execute-api/aws4_request, SignedHeaders=host;user-agent;x-amz-access-token, Signature=5d672d79c15b13162d9279b0855cfba6789a8edb4c82c400e06b5924aEXAMPLE host: https://sellingpartnerapi-eu.amazon.com user-agent: My Selling Tool/2.0 (Language=Java/1.8.0.221; Platform=Windows/10) x-amz-access-token=Atza|IQEBLjAsAhRmHjNgHpi0U-Dme37rR6CuUpSREXAMPLE x-amz-date: 20190430T123600Z
認証情報スコープ
認証情報スコープとは、Selling Partner APIへのリクエストに署名する際に作成する「署名文字列」のコンポーネントです。ステップ4.リクエストの作成と署名をご覧ください。
認証情報スコープは、次の表に示すように、スラッシュで区切られたディメンション文字列で表されます。
ディメンション | 説明 | 例 |
---|---|---|
Date | リクエストの年(YYYY)、月(MM)、日(DD)を表す8桁の文字列。 | 20190430 |
AWS region | リクエストを送信するリージョン。Selling Partner APIエンドポイントを参照してください。 | us-east-1 |
Service | リクエストしているサービス。この値はエンドポイントにあります。Selling Partner APIエンドポイントを参照してください。 | execute-api |
Termination string | 特別な終了文字列。AWS署名バージョン4の場合、値はaws4_requestです。 | aws4_request |
例:
20190430/us-east-1/execute-api/aws4_request
重要認証情報スコープの一部として使用する日付は、x-amz-dateヘッダーで指定されたリクエストの日付と一致する必要があります。詳しくは、AWSドキュメントの署名バージョン4の日付の処理を参照してください。
詳細については、ステップ4.リクエストの作成と署名をご覧ください。
Authorizationヘッダー
Authorizationヘッダーには、要求に対する署名情報が含まれます。ヘッダーは「Authorization」という名前ですが、署名情報は認証に使用されるものです。
Authorizationヘッダーのコンポーネントは次のとおりです。
ヘッダーコンポーネント | 説明 |
---|---|
署名に使用されるアルゴリズム | 署名プロセス全体で使用されるハッシュアルゴリズム。Selling Partner APIには、SHA-256が必要です。これは、ステップ4.リクエストの作成と署名を指定します |
認証情報 | AWSアクセスキーIDは、ステップ3.IAMユーザーを作成するを参照してください。 |
署名付きヘッダー | 署名付きリクエストに含めたすべてのHTTPヘッダーのリスト。例については、ステップ3.URIにヘッダーを追加するをご覧ください。 |
Signature | ステップ4.リクエストの作成と署名をご覧ください。 |
例:
Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20190430/us-east- 1/execute-api/aws4_request, SignedHeaders=host;user-agent;x-amz-access- token;x-amz-date, Signature=5d672d79c15b13162d9279b0855cfba6789a8edb4c82c400e06b5924aEXAMPLE
詳細については、ステップ4.リクエストの作成と署名をご覧ください。
レスポンスのフォーマット
HTTPリクエストへの応答で、Selling Partner APIはレスポンスヘッダーとJSONレスポンスメッセージを返します。
レスポンスヘッダー
名前 | 説明 |
---|---|
Content-Length | HTTPレスポンスヘッダー。 |
Content-Type | HTTPレスポンスヘッダー。 |
Date | HTTPレスポンスヘッダー。 |
x-amzn-ErrorType | エラータイプ。 |
x-amzn-RequestId | リクエストID。サポートが必要な場合は、問い合わせ時にこの内容をお伝えください。 |
成功した場合のレスポンス
リクエストが成功すると、Selling Partner APIはリクエストされたデータを返します。以下に、getOrders APIのコールが成功した場合のレスポンス例を示します。
HTTP/1.1 200 OK Content-Length: 368 Content-Type: application/json Date: Thu, 07 Jun 2019 22:23:31 GMT x-amzn-RequestId: 6875f61f-6aa1-11e8-98c6-9b9a3a7283a4 { "pagination": { "nextToken": "2YgYW55IGNhcm5hbCBwbGVhc3VyZS4" }, "orders": [ { "order": { "purchaseOrderNumber": " L8266355", "orderDetails": { "purchaseOrderDate": "2019-07-16T19:17:34.304Z", "purchaseOrderType": "RegularOrder", "paymentMethod": "Invoice", "buyingParty": { "partyId": "NAG1" }, "sellingParty": { "partyId": "999US" }, "shipToParty": { "partyId": "NAG1" }, "billToParty": { "partyId": "NAG1" }, "items": [ { "itemSequenceNumber": "00001", "amazonProductIdentifier": " ABC123434", "vendorProductIdentifier": "028877454078", "title": "Baby Dove Baby Wipes Rich Moisture (50 Pieces)", "orderedQuantity": { "amount": "10", "unitOfMeasure": "Cases", "unitSize": "5" }, "isBackOrderAllowed": "N", "netCost": { "amount": "10.2", "currencyCode": "USD" } } ] } } } ] }
エラーレスポンス
リクエストが失敗した場合、Selling Partner APIはエラーレスポンスを返します。エラーレスポンスのレスポンスメッセージに含まれる要素は次のとおりです。
レスポンスメッセージ
要素 | 説明 | 必須 |
---|---|---|
code | HTTPステータスコード。 | はい |
message | エラー状態の説明。 | はい |
details | 追加情報へのリンク。 | いいえ |
エラーレスポンスの例を次に示します。
HTTP/1.1 400 Bad Request Content-Length: 117 Content-Type: application/json Date: Fri, 08 Jun 2019 00:48:28 GMT x-amzn-ErrorType: ValidationException x-amzn-RequestId: a8c8d99a-6ab5-11e8-b0f8-19363980175b { "code": "400", "message": "The request could not be understood by the server due to malformed syntax(構文が正しくないため、リクエストをサーバーが理解できませんでした)" }
すべてのリクエストにUser-Agentヘッダーを含める
User-Agentヘッダーは、アプリケーションとそのバージョン番号、および使用しているプラットフォームとプログラミング言語を識別します。Selling Partner APIに送信するリクエストごとに、User-Agentヘッダーを含める必要があります。これにより、効率良く問題を診断して解決できるため、Selling Partner APIをより快適に使用いただくことにつながります。
User-Agentヘッダーを作成するには、アプリケーション名から開始し、スラッシュ、アプリケーションのバージョン、スペース、左丸括弧、言語名の値ペア、右丸括弧の順に入力します。言語パラメーターは必須の属性ですが、セミコロンで区切ることでその他の属性を追加することができます。
次の擬似コードは、受け入れ可能な最小限度の条件を満たすUser-Agentヘッダーを説明するものです。
AppId/AppVersionId (Language=LanguageNameAndOptionallyVersion)
以下に、外部アプリケーションインテグレーターで使用されるUser-Agentヘッダーの例を示します。
My Selling Tool/2.0 (Language=Java/1.8.0.221; Platform=Windows/10)
自社のIT部門を通じてインテグレーションを行っている大規模なベンダーである場合は、User-Agentヘッダーを以下のように使用できます。これにより、Selling Partner APIがHost属性を使用して問題解決をサポートします。
MyCompanyName/build1611 (Language=Perl; Host=jane.desktop.example.com)
その他の属性を指定するには、AttributeName=Value;のフォーマット(名前と値のペアをセミコロンで区切る)を使用します。バックスラッシュ(\)を使用したい場合は、2つつなげて(\\)エスケープして使用してください。アプリケーション名内のスラッシュ(\/)、アプリケーションバージョン内の左丸括弧(\()、属性名内の等号(\=)、右丸括弧(\))および属性値内のセミコロン(\;)についても同様にエスケープし使用してください。
User-Agentヘッダはすべてのリクエストで送信されるので、ヘッダのサイズを制限することをお勧めします。Selling Partner APIは、500文字を超えるUser-Agentヘッダーを拒否します。
Selling Partner APIサンドボックス
Selling Partner APIでは、本番環境上のデータに影響を与えたり、実際のイベントを発生させたりすることなく、アプリケーションをテストできるサンドボックス環境が提供されます。Selling Partner APIへのサンドボックス環境のコールは、Selling Partner APIサンドボックスエンドポイントへのコールする点以外は、本番環境と同じです。認可モデルと認証モデルは、サンドボックス環境上も本番環境上も同じです。サンドボックスエンドポイントに対してコールすると、すべてのSelling Partner APIに、静的でモックされたレスポンスが返されます。コールするAPIのSwaggerモデルJSONファイルで、これらのモックされたレスポンスを参照できます。詳細については、Selling Partner APIをサンドボックスでコールする方法をご覧ください。
Selling Partner APIサンドボックスは、多くのモックされたフレームワークと同じように機能し、指定されたパラメーターが存在する場合は、パターンマッチングを使用して、指定されたレスポンスを返します。開発者が、指定されたパラメーターに一致するリクエストを送信すると、x-amazon-spds-sandbox-behaviorsオブジェクトで定義されたレスポンスが返されます。
サンドボックスエンドポイントに送信されたリクエストが、x-amazon-spds-sandbox-behaviorsオブジェクトのパラメーター値と一致しない場合、レスポンスで「500 Internal Server Error/内部サーバーエラー」を受け取ります。モデルで指定されている正確な値でリクエストを送信する必要があります。
x-amazon-spds-sandbox-behaviorsオブジェクトで指定されていないパラメーターがAPIで必要な場合は、リクエストが有効な限り、リクエスト内のパラメーター値に関係なく、サンドボックスからレスポンスが返されます。
重要サンドボックスは、スケールテストではなく、機能をテストするためのものです。サンドボックスエンドポイントでのコールには、rate = 1秒あたり5リクエスト、burst = 15のスロットリング制限が適用されます。
Selling Partner APIをサンドボックス環境でコールする方法
前提条件
この手順を完了するには、SwaggerモデルのJSONファイル(vendorOrders.jsonなど)が必要です。
SwaggerモデルのJSONファイルは、当社が提供したSDKに(この開発者ガイドとともに)含まれています。
ステップ1.リクエストパラメーターのJSONファイルをチェックする
-
コールするAPIのJSONファイルを開きます。
-
"x-amazon-spds-sandbox-behaviors"
を検索します。
JSONファイルのx-amazon-spds-sandbox-behaviorsオブジェクトには、APIのサンドボックス上でのコールのリクエストとレスポンスの例が含まれています。リクエスト例にパラメーターが含まれている場合は、次のステップで使用します。
ステップ2.APIをサンドボックスでコールする
サンドボックスでAPIをコールする方法は、本番環境でコールする方法と同じですが、以下の違いがあります。
-
JSONファイルの
x-amazon-spds-sandbox-behaviors
オブジェクト内のリクエストオブジェクトに、パラメーターや値のペアが含まれている場合は、コール時にそれを指定します。 -
Selling Partner APIサンドボックスエンドポイントに対しAPIをコールします。
受信するレスポンスは、JSONファイルのx-amazon-spds-sandbox-behaviors
オブジェクトに含まれるペイロードオブジェクトと一致する必要があります。
Selling Partner APIサンドボックスのエンドポイント
Selling Partner APIには、取引を行うリージョンである、北米、ヨーロッパ、アジアパシフィックにサンドボックスエンドポイントがあります。詳細については、Selling Partner APIサンドボックスを参照してください。
取引リージョン | エンドポイント | AWSリージョン |
---|---|---|
北米(カナダ、米国、メキシコ、ブラジルのマーケットプレイス) | https://sandbox.sellingpartnerapi-na.amazon.com | us-east-1 |
ヨーロッパ(スペイン、イギリス、フランス、ドイツ、イタリア、トルコ、アラブ首長国連邦、インドのマーケットプレイス) | https://sandbox.sellingpartnerapi-eu.amazon.com | eu-west-1 |
アジアパシフィック(シンガポール、オーストラリア、日本のマーケットプレイス) | [https://sandbox.sellingpartnerapi-fe.amazon.com](https://sandbox.sellingpartnerapi-fe.amazon.com) | us-west-2 |
ベンダーセントラルのURL
以下に、マーケットプレイス別のベンダーセントラルのURLを示します。
北米
マーケットプレイス | ベンダーセントラルのURL |
---|---|
カナダ | https://vendorcentral.amazon.ca |
米国 | https://vendorcentral.amazon.com |
メキシコ | https://vendorcentral.amazon.com.mx |
ヨーロッパ
アジアパシフィック
マーケットプレイス | ベンダーセントラルのURL |
---|---|
オーストラリア | https://vendorcentral.amazon.com.au |
日本 | https://vendorcentral.amazon.co.jp |
シンガポール | https://vendorcentral.amazon.com.sg |
南アメリカ
マーケットプレイス | ベンダーセントラルのURL |
---|---|
ブラジル | https://vendorcentral.amazon.com.br |