サンプル・プログラムの実行例
サンプル・プログラム
| searchBook.php | サンプル・プログラム本体。 |
| pahooRakuten.php | 楽天ウェブサービスに関わるクラス pahooRakuten。 使い方は「PHPで最寄りのネットができるホテルを検索する」などを参照。include_path が通ったディレクトリに配置すること。 |
| pahooInputData.php | データ入力に関わる関数群。 使い方は「数値入力とバリデーション」「文字入力とバリデーション」などを参照。include_path が通ったディレクトリに配置すること。 |
| バージョン | 更新日 | 内容 |
|---|---|---|
| 3.2.0 | 2025/03/30 | pahooInputData.php導入, 参考URL変更 |
| 3.1.1 | 2024/09/23 | 参考URL変更 |
| 3.1 | 2021/10/24 | PHP8対応，リファラ・チェック改良 |
| 3.0 | 2016/02/27 | pahooRakutenクラスに変更 |
| 2.02 | 2015/07/05 | SSLv3脆弱性対応 |
| バージョン | 更新日 | 内容 |
|---|---|---|
| 3.6.2 | 2023/07/09 | bug-fix |
| 3.6.1 | 2022/12/13 | PHP8.2対応 |
| 3.6 | 2022/02/05 | 楽天商品検索API (version:2017-07-06）に変更 |
| 3.5 | 2021/10/24 | PHP8対応 |
| 3.4 | 2020/05/24 | 楽天書籍API (version:2017-04-04）に変更 |
| バージョン | 更新日 | 内容 |
|---|---|---|
| 1.8.1 | 2025/03/15 | validRegexPattern() -- debug |
| 1.8.0 | 2024/11/12 | validRegexPattern() 追加 |
| 1.7.0 | 2024/10/09 | validURL() validEmail() 追加 |
| 1.6.0 | 2024/10/07 | isButton() -- buttonタグに対応 |
| 1.5.0 | 2024/01/28 | exitIfExceedVersion() 追加 |
楽天ブックス書籍検索API
ここでは、書籍タイトルまたはISBNコードを検索キーに使う。
| ＵＲＬ |
|---|
| https://app.rakuten.co.jp/services/api/BooksBook/Search/20130522 |
| フィールド名 | 要否 | 内 容 |
|---|---|---|
| applicationId | 必須 | 楽天ウェブサービスのアプリケーションID |
| format | 任意 | 'xml'または'json' 【デフォルト】json |
| title | ★ | 書籍タイトル UTF-8でURLエンコードした文字列。複数キーワードから検索したい場合は、半角スペースで区切る。 |
| author | ★ | 著者名 UTF-8でURLエンコードした文字列。複数キーワードから検索したい場合は、半角スペースで区切る。 |
| publisherName | ★ | 出版社名 UTF-8でURLエンコードした文字列。複数キーワードから検索したい場合は、半角スペースで区切る。 |
| size | ★ | 書籍のサイズ 0:全て 1:単行本 2:文庫 3:新書 4:全集・双書 5:事・辞典 6:図鑑 7:絵本 8:カセット,CDなど 9:コミック 10:ムックその他 |
| isbn | ★ | ISBNコード（10進数13桁） |
| booksGenreId | ★ | 楽天ブックスにおけるジャンルを特定するためのID |
| hits | 任意 | 1ページあたりの取得件数 1から30までの整数 【デフォルト】30 |
| page | 任意 | 取得ページ 1から100までの整数 【デフォルト】1 |
| availability | 任意 |
在庫状況 0：すべての商品【省略時】 1：在庫あり 2：2～3日以内に発送予定 3：1～2週間以内に発送予定 4：予約受付中 |
| outOfStockFlag | 任意 | 品切れ等購入不可商品表示フラ 0：品切れや販売終了など購入不可の商品は結果に表示させない【省略時】 1：品切れや販売終了など購入不可の商品を結果に表示させる |
| chirayomiFlag | 任意 |
チラよみフラグ 0：すべての商品【省略時】 1：チラよみ対象商品で絞り込む |
| sort | 任意 |
ソート standard:標準【省略時】 sales:売れている +releaseDate:発売日(古い) -releaseDate:発売日(新しい) +itemPrice:価格が安い -itemPrice:価格が高い +reviewCount:レビューの件数が少ない -reviewCount:レビューの件数が多い |
| carrier | 任意 | PC用の情報を返すのか、モバイル用の情報を返すのかを選択 PC: 0【省略時】 mobile: 1 |
| genreInformationFlag | 任意 |
ジャンルごとの商品数取得フラグ 0 :ジャンルごとの商品数の情報を取得しない【省略時】 1 :ジャンルごとの商品数の情報を取得する |
準備：pahooRakuten クラス
pahooRakuten.php
16: // 楽天ウェブサービス・クラス ===============================================
17: class pahooRakuten {
18: var $error; //エラー・フラグ
19: var $errmsg; //エラー・メッセージ
20: var $hits; //検索ヒット件数
21: var $webapi; //直前に呼び出したWebAPI URL
22:
23: //楽天ウェブサービス
24: //https://www.pahoo.org/e-soul/webtech/php06/php06-01-02.shtm#Rakuten 参照
25: var $APPLICATIONID = '*******************'; //アプリID
26: var $APPLICATION_SECRET = '****************'; //シークレット
27: var $AFFILIATEID = '*******************'; //アフィリエイトID
クラスについては「PHPでクラスを使ってテキストの読みやすさを調べる」を参照されたい。
楽天ウェブサービスには、アプリID や アフィリエイトID が必要で、その入手方法は「楽天ウェブサービス - WebAPIの登録方法」を参照されたい。
解説：WebAPIコール
pahooRakuten.php
76: /**
77: * WebAPIを呼び出して応答データを取得する（https用）
78: * @param string $url リスクエストURL
79: * @return string 応答データ／FALSE=失敗
80: */
81: function callWebAPI($url) {
82: $ch = curl_init($url);
83: curl_setopt($ch, CURLOPT_HEADER, FALSE);
84: curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
85: curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); //サーバ証明書検証をスキップ
86: curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE); // 〃
87: $result = curl_exec($ch);
88: curl_close($ch);
89:
90: return $result;
91: }
解説：応答データの扱い
pahooRakuten.php
156: /**
157: * 楽天ブックスAPIで書籍検索
158: * @param string $query ISBN番号または書籍名
159: * @param string $author 著者名
160: * @param array $items 検索結果を格納する配列
161: * @param string $sort ソート（省略時：standard）
162: * @return ヒットした件数／FALSE：検索に失敗
163: */
164: function searchBooks($query, $author, &$items, $sort='standard') {
165: $url = $this->searchBooksURL($query, $author, $sort);
166: if (($res = $this->callWebAPI($url)) == FALSE) {
167: $this->error = TRUE;
168: $this->errmsg = 'WebAPI呼び出しに失敗';
169: return FALSE;
170: }
171: $this->webapi = $url;
172:
173: //PHP4用; DOM XML利用
174: if ($this->isphp5over() == FALSE) {
175: if (($dom = domxml_open_mem($res)) == NULL) return FALSE;
176: $root = $dom->get_elements_by_tagname('root');
177:
178: //レスポンス・チェック
179: $count = $root[0]->get_elements_by_tagname('count');
180: $cnt = $count[0]->get_content();
181: if ($cnt <= 0) { //ヒットせず
182: $this->error = TRUE;
183: $this->errmsg = '検索結果なし';
184: return FALSE;
185: }
186: //書籍情報取りだし
187: $obj = $root[0]->get_elements_by_tagname('Items');
188: $obj = $obj[0]->get_elements_by_tagname('Item');
189: $cnt = 1;
190: foreach ($obj as $val) {
191: foreach ($this->RakutenBooksItems as $name) {
192: $node = $val->get_elements_by_tagname($name);
193: if ($node != NULL) {
194: $items[$cnt][$name] = $node[0]->get_content();
195: }
196: }
197: $items[$cnt]['title'] = preg_replace("/([あ-ん|ア-ン])-/ui", "$1ー", $items[$cnt]['title']);
198: $items[$cnt]['titleKana'] = preg_replace("/([あ-ん|ア-ン])-/ui", "$1ー", $items[$cnt]['titleKana']);
199: $cnt++;
200: }
201:
202: //PHP5用; SimpleXML利用
203: } else {
204: $xml = simplexml_load_string($res);
205: //レスポンス・チェック
206: $count = (int)$xml->count;
207: if ($count <= 0) { //ヒットせず
208: $this->error = TRUE;
209: $this->errmsg = '検索結果なし';
210: return FALSE;
211: }
212: $obj = $xml->Items->Item;
213: $cnt = 1;
214: foreach ($obj as $node) {
215: foreach ($this->RakutenBooksItems as $name) {
216: if (isset($node->$name)) {
217: $items[$cnt][$name] = (string)$node->$name;
218: }
219: }
220: $items[$cnt]['title'] = preg_replace("/([あ-ん|ア-ン])-/ui", "$1ー", $items[$cnt]['title']);
221: $items[$cnt]['titleKana'] = preg_replace("/([あ-ん|ア-ン])-/ui", "$1ー", $items[$cnt]['titleKana']);
222: $cnt++;
223: }
224: }
225: $this->hits = $cnt - 1;
226:
227: return $this->hits;
228: }
参考サイト
- 楽天ブックス書籍検索API：楽天市場
- PHPでAmazonを利用して新刊書籍を検索：ぱふぅ家のホームページ
- Ajax - Amazonと楽天に二股かけてみる：404 Blog Not Found
- 楽天APIの結果がサイトの検索結果と異なる？！：頭と尻尾はくれてやる！
今回は、その中から楽天ブックスが販売する書籍の検索ができる楽天ブックス書籍検索APIを利用し、書名、著者名またはISBNコードから書籍情報を取り出すプログラムを作ってみることにする。
（2025年3月30日）pahooInputData.php導入, 参考URL変更