5. 実践の前に：サンドボックス環境でAPIを安全に試そう

前回の記事はこちら

前回の記事では、APIを利用するための「APIキーセット（アプリの身分証明書）」と「ユーザートークン（あなたからの委任状）」という、2つの重要な鍵を手に入れました。これで、APIに指示を出す準備は万全です。

しかし、いきなり実際の店舗で試すのは少し怖いですよね。もし操作を間違えて、大事な商品の情報を変えてしまったら大変です。

そこで今回は、本番の店舗に一切影響を与えずに、心ゆくまでAPIの練習ができる安全な練習場、「サンドボックス環境」についてご紹介します。

サンドボックスとは？ 安全な「砂場」で遊ぼう

サンドボックス（Sandbox）とは、その名の通り「砂場」を意味します。子供たちが砂場で自由に山やトンネルを作って遊ぶように、開発者やセラーがリスクなくAPIを試すことができる、隔離されたテスト環境のことです。

このサンドボックスは、本物のeBayサイト（本番環境）とそっくりに作られていますが、完全に独立しています。ここで何が起きても、あなたの実際の店舗データ、商品、売上には一切影響しません。

• サンドボックスで商品を出品しても、実際には出品されない。

• サンドボックスで商品を削除しても、実際の在庫は減らない。

• サンドボックスでの操作は、もちろん手数料もかからない。

APIの操作に慣れるまでは、まずこのサンドボックスで十分に練習することが、成功への一番の近道です。

1. 練習の準備：サンドボックス用のテストユーザーを作成する

サンドボックス環境で遊ぶためには、サンドボックス専用の住人、つまり「テストユーザー」が必要です。このユーザーも、あなたの本番アカウントとは無関係です。

前編では既にテストユーザーを用意できたでしたら、ここでの手順をスキップしても構えません、どんどん進んで行きましょう。

テストユーザー作成手順

1. eBay開発者ポータルにログインします。

2. 右上にあるメニューからUser Access Tokensを探してクリックします。

3. 開いたUser Tokens(eBay Sign-In)ページで Register a new Sandbox userを探してクリックします

4. 登録フォームが表示されるので、テストユーザーの国、ユーザー名、パスワードなどを入力して作成します。

このテストユーザーは、後でサンドボックス版のeBayサイト（https://sandbox.ebay.com/）にログインして、APIでの操作結果を確認するために使います。

2. 初めてのAPIコール：テスト商品を出品してみよう

準備が整いました。いよいよ、APIを実際に動かしてみましょう。

今回は、プログラミングコードを1行も書かずにAPIを試せる、開発者ポータルの便利ツール「API Explorer」を使ってみます。API Explorerは Develop > Tools > API Explorerで見つけられます。

ここでは例として、Trading APIのAddItemという命令（コール）を使い、テスト商品を1つ出品してみます。下の画像のように、ゆっくりやりましょう。

ステップ１：ツールの設定と認証

まず、API Explorerを開き、私たちが前回取得した鍵と合言葉を設定します。

• Environment (環境): 「Sandbox」を選択します。

• Token (トークン): あなたのサンドボックス用ユーザートークンを入力します。画像の1に書いてあるように、Get OAuth User Tokenをクリックすると、簡単にユーザートークンを貰えます。

ステップ２：「AddItem API」を選択

次に、Select APIにTrading APIを選択し、API CALLにAddItemを選択しましょう。Select API Versionはそのままで結構です。

ステップ３：「注文内容（リクエスト）」の準備

送る「注文内容」を作成します。Trading APIでは、XMLという形式で指示を書くのがルールです。以下のサンプルを、API ExplorerではAPIを選択する度に自動的にリクエスト（Request Body）を入力できます、ここでは複雑なパラメーターをメモしなくても大丈夫です。内容は以下のコード欄にコピー＆ペーストしてみてください。

XML:

<?xml version="1.0" encoding="utf-8"?>
<AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <Item>
    <Title>API練習用のテスト商品</Title>
    <Description>これはAPIを使って出品したテスト商品です。安全なサンドボックス環境で作成されました。</Description>
    <PrimaryCategory>
      <CategoryID>14111</CategoryID>
    </PrimaryCategory>
    <StartPrice>19.99</StartPrice>
    <Country>JP</Country>
    <Currency>JPY</Currency>
    <DispatchTimeMax>3</DispatchTimeMax>
    <ListingDuration>GTC</ListingDuration>
    <PaymentMethods>PayPal</PaymentMethods>
    <PayPalEmailAddress>test@example.com</PayPalEmailAddress>
    <PostalCode>100-0001</PostalCode>
    <ReturnPolicy>
      <ReturnsAcceptedOption>ReturnsAccepted</ReturnsAcceptedOption>
    </ReturnPolicy>
  </Item>
</AddItemRequest>

*GTCは "Good 'Til Cancelled"（キャンセルされるまで出品）の略です。

ステップ4：実行して結果を確認！

入力が完了したら、「Execute」といったボタンを押します。

すると、APIからの「返事（レスポンス）」が表示されます。レスポンスの中に<Ack>Success</Ack>という一文があれば、大成功です！これは「注文、確かに承りました！」というAPIからの合図です。

ステップ5：サンドボックスサイトで出品を確認

最後の仕上げです。ブラウザでサンドボックスサイト（https://sandbox.ebay.com/）にアクセスし、先ほどのレスポンスにあるItemIDをURLに入れ替え、そして、あなたが出品した商品を見てみましょう。この例ですと、https://sandbox.ebay.com/itm/110587755734です。

どうでしょう？「API練習用のテスト商品」が、無事に出品されているはずです！

おめでとうございます！これであなたは、APIとの初めての対話を成功させました。

さて、今回は伝統的なTrading APIを使いましたが、現在eBayでは、よりモダンで使いやすい「RESTful API」という新しい形式のAPIが主流になりつつありますが、Trading APIは商品の出品、在庫連携、商品の修正、商品の取り下げなどに対して完備な機能がお揃いでいます、自分とビッタリ なAPIを使ってみましょう。

次回は、そのモダンな「RESTful API」の世界を覗いてみます。特に在庫管理や注文処理で強力なInventory APIやFulfillment API、そしてOAuth2.0をご紹介していきます。

APIは難しくない！あなたのビジネスを加速させる魔法の杖です。

リファレンス：サンドボックス環境 vs 本番環境と主な違い一覧