SP-APIリクエストをPostmanで確認する方法

APIを使ったアプリを作っててうまく動作しない場合、
そもそもAPIを正しく叩けてるんだっけ?と不安になりますよね。
そこで、POSTMANを使ってAmazon SP-APIの動作確認方法を紹介。
なお、他のAPIであっても、同様の方法で確認できます。
 ※Postman API Platform <https://www.postman.com/>

アカウント作成

アカウント作成ページを開き、必要事項を入力して「Create free account」を選択する。
 <https://identity.getpostman.com/signup>

postman、User Create

・名前と役職を入力して「Continue」を選択する。

postman、User Create

・「Continue without team」を選択する。※関係者がいる場合は関係者のメアドを記載

postman、User Create

・Welcomeメッセージが表示されるため「×」ボタンで閉じる。

postman、User Create

・ログインできると下記のような画面が表示される。

postman、User Create

アクセストークン取得

※SP-APIの設定が済んでいる前提で記載

・「New」を選択して新しくファイルを作成する。

postman、GetAccessTocken、SP-API

・「HTTP Request」を選択する。

postman、GetAccessTocken、SP-API

・「Save As…」で、一旦保存する。

postman、GetAccessTocken、SP-API

・リクエスト名を入力し、「Create a collection」を選択する。
 例)リクエスト名:GET_ACCESS_TOCKEN

postman、GetAccessTocken、SP-API

・コレクション名(≒プロジェクト名)を入力し、「Create」を選択する。

 例)コレクション名:TEST_COLLECTION

postman、GetAccessTocken、SP-API

・「Save」を選択する。

postman、GetAccessTocken、SP-API

・以下のような画面表示となり、保存できたことを確認する。

 例)コレクション:TEST_COLLECTION > リクエスト:GET_ACCESS_TOCKEN

postman、GetAccessTocken、SP-API

・アクセストークン取得に必要となる情報、パラメータを入力する。

CategoyKeyValue
HTTPメソッドPOST
URLhttps://api.amazon.com/auth/o2/token
Params
Auth
Header-※デフォルトのhiddenのみ
Bodyx-www-form-urlencoded
Bodygrant_typerefresh_token
Bodyrefresh_token<リフレッシュトークン>
Bodyclient_id<LWA 認証情報 クライアントID>
Bodyclient_secret<LWA 認証情報 クライアント機密情報>
Pre-req
Tests
Settings
SP-APIリクエストでアクセストークンを取得するためのパラメータ一覧

 入力例)

postman、GetAccessTocken、SP-API

・「Save」を選択して設定値を保存する。

・「Send」を選択することで、トークン取得のリクエストを飛ばす。

・「Response」画面でリクエストの結果を確認する。

 例)正常に取得できた場合

 例)異常時のメッセージ例

異常①:「grant_type」のパラメータ設定が不足している。

{
    "error_description": "The authorization grant type is not supported by the authorization server",
    "error": "unsupported_grant_type"
}

異常②:「refresh_token」のパラメータ設定が不足している。

{
    "error_description": "The request is missing a required parameter : refresh_token",
    "error": "invalid_request"
}

異常③:「client_id」が登録されていない、不正な値である。

{
    "error_description": "Client authentication failed",
    "error": "invalid_client"
}

異常④:「client_secret」が不正な値である。 ※メッセージは、異常③と同じ。

{
    "error_description": "Client authentication failed",
    "error": "invalid_client"
}

アクセストークンの取得

 SP-APIリクエスト(アクセストークン取得)
 想定するAPI:
  https://api.amazon.com/auth/o2/token

GetCatalogItemの取得(ASINコードから)

 SP-APIリクエスト(商品情報取得)
 想定するAPI:
  https://sellingpartnerapi-fe.amazon.com/catalog/2020-12-01/items/

GetCatalogItemの取得(JANコードから)

 SP-APIリクエスト(商品情報取得JAN)
 想定するAPI:
  https://sellingpartnerapi-fe.amazon.com/catalog/2020-12-01/items/

GetPriceの取得(ASINコードから)

 SP-APIリクエスト(価格取得)

 想定するAPI:
  https://sellingpartnerapi-fe.amazon.com/products/pricing/v0/items/{ASIN}/offers?

関連記事

phpでSP-APIを利用する方法(認証編)
SP-APIリクエスト(アクセストークン取得)
SP-APIリクエスト(商品情報取得)
SP-APIリクエスト(商品情報取得JAN)
SP-APIリクエスト(価格取得)

参考

Postman API Platform
 https://www.postman.com/
【Postman】配列データを送るやり方を解説します
 https://www.tairaengineer-note.com/postman-send-array/

コメント

タイトルとURLをコピーしました