ヘルプ
目次
ショッピングAPIを利用するには
ショッピングAPIに関連するヘルプ
テスト環境に関連するヘルプ
ショッピングAPIを利用するには
YJDNショッピングAPIの利用フロー
簡易フロー
ショッピングAPIを利用する際の、アプリケーションIDの取得や、各種申請などの簡易フローは以下となります。①ショッピングAPIを利用する
- 本番環境または、テスト環境のどちらで利用するアプリケーションIDかを選択します。
アプリケーションIDの取得は、こちら
https://e.developer.yahoo.co.jp/shopping/register
APIの種類と環境ごとのアプリケーションID
https://developer.yahoo.co.jp/webapi/shopping/help.html#apikindbyappid
②【任意】注文関連のAPIを利用する
- ショッピングAPIのなかでも注文関連のAPI群を利用する場合は、利用申請が必要になります。
(注文APIの利用申請 https://developer.yahoo.co.jp/webapi/shopping/help.html#orderapiapply ）
③【任意】注文関連APIで証明書認証を行う。
- (注文APIの証明書による認証について https://developer.yahoo.co.jp/webapi/shopping/help.html#orderapicertificate ）
④【任意】APIのコール数制限緩和を行う
- 通常取得のアプリケーションIDは、1アプリケーションIDにつき1日5万コールまでの制限がかけられております。
- 利用用途により超過しそうな場合には設定のためのAPIコール数制限緩和のヒアリングシートをご連絡いたします。
※利用する各APIごとに利用するコール数を試算いただく必要がございます。
※高負荷につながる利用の場合お受けできない場合がございます。 - (APIのコール数制限緩和について https://developer.yahoo.co.jp/webapi/shopping/help.html#requestlimit ）
⑤テスト環境について
- テスト環境用のアプリケーションIDを取得すると、5営業日後にメールでテストストアアカウントをご連絡します。
https://developer.yahoo.co.jp/webapi/shopping/help.html#whatbranch
ショッピングAPIに関連するヘルプ
APIの種類と環境ごとのアプリケーションID発行
| APIの種類 | API名 | 環境 | アプリケーションID |
|---|---|---|---|
| 情報参照系API （YID不要） |
商品検索API ランキングAPI レビュー検索API など |
(1) 本番環境 |
下記ページから取得します。 |
| (2) テスト環境 | ※テスト環境ではご利用いただけません。 | ||
| ストア運営をサポートするAPI （YID必要） |
注文系API 商品系API 在庫系API など |
(3) 本番環境 |
下記ページから取得します。 「どちらの用途で発行しますか？」では「本番環境用」を指定 |
| (4) テスト環境 |
下記ページから取得します。 「どちらの用途で発行しますか？」では「テスト環境用」を指定 ※テストアカウントはメールでお知らせします。 |
本番環境の注文APIの利用申請について
現在、本番環境の注文APIを審査のうえで利用できる方は以下の通りです。
- Yahoo!ショッピングのプロフェッショナル出店プランの方
- Yahoo!コマースパートナーの方
該当される方で利用希望の場合は、下記フォームからお申し込みください。
【注文API利用申請フォーム】
https://business-yahoo.smartseminar.jp/public/application/add/1141
本番環境の注文APIの証明書による認証について
注文に関するAPIでは証明書を利用した認証を行うことで、Yahoo! JAPAN IDによる再認可までの期間を延長できます。（テスト用APIは対応していません）
証明書認証できるAPI
YConnectのみを利用する場合は、上記のAPIでは最大12時間で再認可が必要でしたが、YConnectと証明書を組み合わせることで最大4週間まで延長できます。
※証明書を利用しなくてもAPIは利用できます。
証明書の申請方法
証明書は、プロフェッショナル出店ストアのみ申請が可能です。証明書を希望の方は、「ストアクリエイターPro >各種申請」から申し込みしてください。
ただし、申請案内ページにはストアクリエイターProにアクセスできるYahoo! JAPAN IDでログインしている必要があります。
また、申請から証明書の取得までは最大5営業日かかる場合があります。
証明書の取得方法について
証明書が発行されると、ストアクリエイターProより[ダウンロード]ボタンが表示されます。(ツール管理権限が必要です)メールでのご連絡はありませんのでご注意ください。
ダウンロードしたファイル(.crt)を「証明書」に指定してご利用ください。（詳細はサンプルコードを参照）
秘密鍵の取得方法について
「証明書」と同じタイミングでダウンロードが可能です。ダウンロードしたファイル(.key)を「秘密鍵」に指定してご利用ください。（詳細はサンプルコードを参照）
証明書の有効期限について
注文APIの証明書有効期限は発行した月より1年間となります。期限が近づいた方にはストアの管理者の方にメールでご連絡させていただきます。
更新するための証明書が有効期限切れとなる1カ月前よりダウンロード可能となりますので、有効期限までに証明書の更新をお願いいたします。（例：2014年9月中に発行されたお客様の証明書有効期限は2015年8月末となります。）
Yahoo!ショッピング出店ストアではない場合
出店ストアではなく証明書を利用したいデベロッパーの方は、出店ストアから証明書（＋秘密鍵）を貸与してもらうことで利用できます。ただし、貸与に関しては証明書を取得したストアの責任の範囲で行われるものです。証明書によるリクエスト方法事例
「証明書」「秘密鍵」には、ストアクリエイターProからダウンロードしたファイルを指定してください。●PHPの場合（サンプル）
<?php
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($ch, CURLOPT_SSLCERT, ‘証明書を指定’);
curl_setopt($ch, CURLOPT_SSLKEY, ‘秘密鍵を指定’);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postdata);
$result = curl_exec($ch);
curl_close($sh);
?>
●Javaの場合（サンプル）
# 証明書と秘密鍵を結合したPKCS12ファイルを作る
$ openssl pkcs12 -export -inkey "秘密鍵を指定" -in "証明書を指定" -out "出力ファイル名"
public class APIClientSample {
static final String URL = "APIのURL";
static final String P12FILE = "出力したPKCS12ファイル";
static final char[] PASSWORD = "PKCS12ファイル作成で指定したパスワード".toCharArray();
public static void main(String[] args) {
// PKCS12ファイル読み込み
KeyManagerFactory keyManagerFactory;
try (FileInputStream inputStream = new FileInputStream(P12FILE)) {
KeyStore keyStore = KeyStore.getInstance("PKCS12");
keyStore.load(inputStream, PASSWORD);
keyManagerFactory = KeyManagerFactory.getInstance("SunX509");
keyManagerFactory.init(keyStore, PASSWORD);
SSLContext sslContext = SSLContext.getInstance("TLS");
sslContext.init(keyManagerFactory.getKeyManagers(), null, null);
HttpsURLConnection.setDefaultSSLSocketFactory(sslContext.getSocketFactory());
} catch (KeyStoreException | NoSuchAlgorithmException | CertificateException | IOException | UnrecoverableKeyException | KeyManagementException e) {
e.printStackTrace();
}
// 以下省略
テスト環境に関連するヘルプ
プロフェッショナル出店、ライト出店とは
プロフェッショナル出店とライト出店は、Yahoo!ショッピングが提供するツールが異なります。
機能を比較したものは、こちらをご確認ください。
テスト用APIとは
テスト用APIは、Yahoo!ショッピングのサービス中のシステムとは切り離された環境で使えるAPIです。
申請すればどなたでもご利用いただけます。
そのため、テスト用APIで商品を登録しても実際のYahoo!ショッピングに商品が掲載されることはありません。
テスト用APIとして利用できるAPIは、こちらのプロフェッショナル出店ストア向けAPIになります。
テスト用APIを利用するには
テスト用APIを利用したい場合は、下記フォームから「テスト用環境」を選択してアプリケーションIDを取得してください。
利用申請から最大5営業日で、利用のために必要なお知らせをメールにてご連絡いたします。その際に、テスト用APIの情報等をお知らせいたします。
ご連絡はアプリケーションIDを取得したときのYahoo! JAPAN IDに登録されているメールアドレス宛てにお送りいたします。
【アプリケーションID取得ページ】
https://e.developer.yahoo.co.jp/shopping/register
テスト用ストアアカウントを変更したい
利用申請された方に発行されるテスト用ストアアカウントは変更できません。
また、指定することもできません。ご了承ください。
テスト用ストアアカウントを追加したい
ひとつのYahoo! JAPAN IDにつき、1つのテスト用ストアアカウントしか発行できません。
再度テスト環境の利用申請時とは異なるYahoo! JAPAN IDにて利用申請していただければ、別のテスト用ストアアカウントが発行されます。
テスト用ツールを利用するには
テスト用ツールには、ストアクリエイターPro、ストアエディターの2つのツールを利用できます。
ストアクリエイターProとは、注文情報の管理や、ストア設定などのストア運営に必要な作業を行うためのツールになります。
ストアエディターとは、商品管理、在庫管理など出品に関する設定を行うためのツールになります。
このツールは法人の出店者様が利用できるツールとなります。
テスト用ツ－ルを利用したい場合は、下記フォームから「テスト用環境」を選択してアプリケーションIDを取得してください。
利用申請から最大5営業日で、テスト用ツールの情報ををお知らせいたします。
ご連絡はアプリケーションIDを取得したときのYahoo! JAPAN IDに登録されているメールアドレス宛てにお送りいたします。
【アプリケーションID取得ページ】
https://e.developer.yahoo.co.jp/shopping/register
ストアマネージャーをご利用いただいていた方へ
ストアマネージャーは『ストアクリエイターPro』にツールが新しくなります。そのため、ストアマネージャーでの設定は無効化されます。 ストアマネージャーで行っていた各種設定はストアクリエイターProにてお願いします。 また、ストアマネージャーの設定情報はストアクリエイターProに移行はされませんので、お手数ですが再度設定をお願いします。
テスト環境を利用する際の注意点
テスト環境では利用できない機能があります。
- ストアクリエイターPro、ストアエディターのいくつかのリンク先にYahoo! JAPANビジネスID認証がかかっているものがあります。こちらはYahoo!ショッピングとの出店契約でYahoo! JAPANビジネスIDを持っている方しか閲覧できません。
また、下記の本番環境とテスト環境で利用できる機能比較表をご覧ください。
| 機能名 | 本番環境 | テスト環境（SandBox） | 備考 | |
|---|---|---|---|---|
ツール 機能 |
ストア アカウント |
本番用のストアアカウント | snbx-[10バイト前後の乱数文字列] | テスト環境は間違えやすいのでご注意ください。 |
| ツール ログインID |
ビジネスIDに紐づくYahoo!Japan ID（以下、YID） | テスト環境申請時のYID | ||
| ツールURL | https://pro.store.yahoo.co.jp/pro.[ストアアカウント] | https://test.pro.store.yahoo.co.jp/pro.[テスト環境ストアアカウント] | ||
| 注文管理 | ○ | ○ | ||
| 商品・ 画像・ 在庫等 |
○ | ○ | ||
| ストア構築 | ○ | △ | テスト環境のストア名は「テスト用ストア」固定です。変更できません。 | |
| クーポン | ○ | × | ||
| ストアニュースレター | ○ | × | ||
| トリプル | ○ | × | ||
| 広告 | ○ | × | ||
| 統計 | ○ | × | ||
| 評価・レビュー | ○ | × | ||
| 利用明細 | ○ | × | ||
| 設定 | ○ | △（表示のみで機能しない） | ||
| 権限管理 | ○ | × | ||
| 申し込み情報 | ○ | × | ||
| FTPアップロード | ○ | × | テスト環境では利用不可です。 | |
| 注文・決済 | テスト注文 | ○ | ○ | |
| クレジットカード決済 | ○ | ○ | ||
| コンビニ払い | ○ | × | ||
| ペイジー | ○ | × | ||
| キャリア決済 | ○ | × | ||
| 銀行振込 | ○ | ○ | ||
| 商品代引 | ○ | ○ | ||
| ポイント利用 | ○ | × | ||
| ポイント付与 | ○ | × | ||
| いたずら注文 | ○ | × | ||
| API | 公開WebAPI | ○ | ○ |
出店者が利用するツールについて
プロフェッショナル出店ストア様とライト出店ストア様で利用できるツールが異なります。
| 利用するツール | ツールでできること | |
|---|---|---|
| ライト出店ストア様 | ストアクリエイター | ストア設定・商品管理・デザイン管理・注文管理 |
| プロフェッショナル出店ストア様 | ストアクリエイターPro | ストア設定・注文管理 |
| ストアエディター | 商品管理・デザイン管理 |
※ストアクリエイターProとストアエディターはセットで利用します。
※法人の方はストアクリエイターかストアクリエイターPro&ストアエディターのいずれかを選択します。
よくあるご質問
リクエスト元IPアドレスの変更・追加について
既に注文APIをご利用中のお客様で、リクエスト元IPアドレスに変更・追加が発生した場合は、
再度下記フォームから利用申請をお願いします。
【注文API利用申請フォーム】
https://business-yahoo.smartseminar.jp/public/application/add/1141
APIのコール数制限緩和について
1アプリケーションIDにつき、1日5万コールまでの制限がかけられております。
利用用途により超過しそうな場合には、制限数を緩和させていただきます。（無料）
まずは下記お問い合わせフォームからご相談ください。
【APIコール数制限緩和申請フォーム】
https://business-yahoo.smartseminar.jp/public/application/add/1256
