Amazon Pay Scratchpad ユーザーガイド
Amazon Pay Scratchpadは、Amazon Pay API のいずれかを使用して、簡単にリクエストを送信できるアプリケーションです。 Amazon Pay Scratchpadのユーザーインターフェースから、リクエストの必須およびオプションのパラメータを設定してリクエストをすることができます。 Amazon Payボタンを設定する場合は、Button CodeGeneratorを使用して、ボタンのレンダリングに必要なコードを生成することができます。 Amazon Pay Scratchpadは、有効なリクエスト Signature、必要なヘッダーを自動的に作成し、リクエストをAmazon Pay SANDBOX環境に送信します。 その後、Amazon Payからのレスポンスを表示します。
Amazon Pay Scratchpadは、Amazon Pay APIを使用してソリューションを開発しているソフトウェア開発者にとって有用なツールとなります。 Amazon Pay APIへのリクエストに必要な入力の多くを自動的に生成して表示するため、これらのインプットが正しく形成されたときにどのように見えるかを確認できます。 各APIのリクエストごとに表示するAPIのレスポンスを簡単に確認することができ、Amazon Payのインテグレーションをより簡単に行っていただくことが可能となります。
Amazon Pay Scratchpadを利用する為の前提条件
Amazon Pay Scratchpadを使用するには、Amazon Pay APIにリクエストを送信する基本的な方法について理解している必要があります。詳細はこちらをご覧ください。
Amazon Pay Scratchpadの利用方法
Amazon Payアカウントを登録してAPIキーペアを取得したら、Amazon Pay Scratchpadを使ってAmazon Pay APIとのやり取りを開始できます。 このツールを使用して、Amazon Pay APIにリクエストを送信し、レスポンスを取得します。このツールは、Amazon Pay APIがどのように動作するかを理解するのに役立つサンプルコードを返し、簡単に統合するのに役立ちます。
Amazon Pay SANDBOX環境の有効な認証情報がないと、当ツールを使用することはできません。有効なSANDBOX環境の認証情報をお持ちでない場合は、 Amazon Payへの登録とPublic Key IDの取得を順に確認し、有効な認証情報を取得してください。
利用開始
1.認証情報の設定
Authenticationエリアで、Region、Public Key Id、Private Keyを設定してください。オプションでAuthorization Tokenも設定できます。(Authorization Tokenは基本的にはSaaS型のSPが利用します) 左側のナビゲーションで「Authentication」をクリックすると、認証設定が開き、以下の入力フィールドが表示されます。
Region - 事業者がAmazon Payの利用登録をしたリージョン
Public Key Id - RSA Public Key ID (Merchant/Seller IDではありません)
Private Key - RSA Private Keyのパス
Auth Token - Authorization tokenは、サードパーティの開発者が事業者の代わりにAPI呼び出しを行う場合に利用します。ここに設定した値はヘッダーのX-Amz-Pay-AuthTokenとして渡されます。
2.確認するAPIの選択
左のナビゲーションでAPIセクションを展開して、利用可能なAPI操作のリストを表示し、実行したいAPIをクリックしてリクエストパラメータを設定します。 APIパラメータの必須およびオプションは、APIによって異なります。 パラメータ名の横に"(optional) "とあるものが任意のパラメータです。 各APIとそのパラメータの詳細はAmazon Pay API ドキュメントをご覧ください。
3.APIリクエストの実行
APIの実行に成功した場合は、Amazon Pay Scratchpadは以下の情報をレスポンスとして返却します。
Request Signature Amazon PayへのすべてのAPIリクエストは、あなたのPrivate Keyで署名して保護する必要があります。署名は、リクエスト元を確認し、転送中のデータを保護するために使用されます。 当セクションは、署名を生成し、署名作成の手順をお伝えします。Request Signature セクションは以下の情報を表示します。
- Request Headers - リクエストで使用された正規ヘッダーの後に改行文字を入れたものです。正規ヘッダーは、署名付きリクエストに含めるすべての HTTP ヘッダーのリストです(詳細はインテグレーションガイドをご覧ください) リクエストで使用された正規ヘッダーの後に改行文字を入れたものです。正規へは、署名付きリクエストに含めるすべての HTTP ヘッダーのリストです。 See API introduction for mandatory headers.
- Canonical Request - リクエストの内容 (host, action, headers, etc.) を標準（正規）形式に成形したものです。
- String to sign - ハッシュアルゴリズムの指定（AMZN-PAY-RSASSA-PSS）と正規リクエストのダイジェスト（ハッシュ）を連結して、署名する為の文字列です
API Response - API Responseセクションは以下の情報を表示します。
- Status Code - APIレスポンスのHTTPステータスコードの要素です。 エラーコードの詳細はインテグレーションガイドをご覧ください
- Request ID - APIからレスポンスヘッダで返されるリクエストの一意の識別子
- Response Body - APIから返されるJSON形式のレスポンスボディ
Amazon Payボタン生成の為のScratchpad利用方法
Amazon Payボタンを設定・レンダリングするためのButton Codeのサンプルを表示する機能がScratchpadに含まれています。 認証情報の設定後、左のナビゲーションから Button Code をクリックして、Amazon Payボタンのレンダリングワークフローを表示します。適切なボタンタイプを選択し、次へをクリックしてボタンを設定します。選択したボタンタイプに適したオプションを設定し、Nextをクリックしてボタンをレンダリングし、生成されたコードを表示します。
Button Code
Button Code セクションはボタン描画に必要な HTMLとJavaScriptが表示されます
Sign the payload
Sign the payloadセクションには、Amazon Pay SDKで提供されているヘルパー関数を使用して、ボタンのpayloadJSONの署名を生成するために必要なコードが表示されます。 このSDKは、PHP、.NET、Java、Node.jsの各言語で利用できます。ボタンの署名に関する詳細の情報はインテグレーションガイド(payloadの署名または、SDKを利用しない場合はリクエストの署名)をご覧ください