API導入ガイド

ここでは、Trading APIでSandbox環境で商品を出品するまでの手順を説明します。 アプリケーションからAPIを利用する場合は、特定のプログラミング言語やライブラリーからAPIを呼び出すことになりますが、ここではデベロッパープログラムで紹介されている、 SoapUIというツールを利用します。 最後に実際のAPI呼び出しができるように、次のステップを説明していきます。
  1. アカウント登録
  2. Sandboxユーザ登録
  3. アプリケーションキーの取得
  4. ユーザトークン取得
  5. SoapUIを準備
  6. API呼び出し

デベロッパーアカウント登録

APIを利用するには、eBay developer programでデベロッパーアカウントの登録をする必要があります。eBay developer programにアクセスし、 Registerリンクから新規登録フォームを送信します。 送信後は、登録のメールに受信した案内にしたがって、アカウントを有効化します。

Sandboxユーザ登録

eBay developer programにログイン後、 Sandboxユーザ登録ツール でユーザ登録します。

アプリケーションキーの取得

アプリケーションキーはeBay APIを呼び出す際にデベロッパーを識別するユニークキーです。 My Accountページにあるボタンから、Production、Sandboxのキーを生成して下さい。 キーを生成すると、DevID、AppID、CertID の３つが生成されます。この３つで一つのキーセットとなるので、API呼び出し時に必要になります。
  • DevID : デベロッパーアカウントを識別するキー
  • AppID ： アプリケーションを識別するキー
  • CertID : API呼び出し時にアプリケーションを認証するキー

ユーザトークン取得

eBay developer programにログイン後、ユーザトークンツールを使って、ユーザトークンを取得します。 その際、環境はSandboxを選び、DevID、AppID、CertIDは上で取得したものを使用します。 取得したトークンを後で使うために、ローカルに保存しておきます。

APIテストツールをセットアップ

eBayではAPI呼び出しをテストが手軽に始められるように、APIリクエストのテンプレートを公開しています。 こちらのブログエントリーの手順に従って、SoapUIでTrading APIコールが呼び出せるようにして下さい。

API呼び出し

SoapUIを使って、Trading APIのAddItemコールで商品を出品します。 準備したSoapUIを開き、以下の順に操作します。
  1. SoapUIでTradingAPI_SoapUI_Sample_Projectプロジェクトを開く。
  2. プロジェクト内からeBayAPISoapBinding > AddItem > BasicRequest_XMLを開く
  3. 今回はSandbox環境を使用のため、エンドポイントを https://api.sandbox.ebay.com/ws/api.dll に変更する。
  4. HTTPヘッダーにアプリケーションキーDevID, AppID, CertIDを入れる – DevID : X-EBAY-API-DEV-NAME – AppID : X-EBAY-API-APP-NAME – CertID : X-EBAY-API-CERT-NAME
  5. リクエストXMLに含まれている、<eBayAuthToken>の値を上で取得したユーザトークンで置き換えます。
  6. 最後にSoapUIのSubmitボタンをクリックすると、API呼び出しが実行され、右側パネルにレスポンスが表示されます。 “Your call is returned with Ack = Success(もしくはWarning)” と表示されれば、出品が成功です。
    SoapUI-AddItem
    レスポンスの中身を確認すると、<ItemID>110157698529</ItemID>というような部分があります。 このItemIDが、商品をeBay上で一意的に識別するためのIDです。

最後に

商品がどのように出品されたかは、SandboxのMy Ebayから確認できます。 My EbayのActive Sellingを確認すると、APIで出品した商品が表示されていることが分かります。