【楽天API】

楽天APIを使用できるようにする手順

Rakuten Web Serviceを使えるようにしよう

投稿日 2022/02/14 更新日 2022/02/24


こんにちは。当サイトの管理者「元木皇天」です。

今回は楽天APIを使うために必要な準備などの手準備ついて解説いたします。

楽天APIを使いたいけど、どうしたら使えるようになるのか知りたい人はぜひ読んでみてください。

環境
OS:MacOS Big Sur
楽天商品検索API:Ver 2017-07-06

やりたいこと

楽天APIを使えるようにする

参考文献
Rakuten Web Service サイト

楽天APIとは?

楽天APIとは、楽天が持つ情報(商品リスト・カート情報・その他の機能など)を楽天の会社にいる人以外でも使えるようにしたもの、です。

詳しくは過去の記事で紹介していますので、気になる方は読んでみてください。

過去記事:【楽天API】楽天APIとは何か?何ができるのか?

楽天APIのアプリIDの取得

楽天APIを使用するためには、まずRakuten Web Serviceのアカウントを作成してアプリIDというものを取得する必要があります。

アプリIDの取得は以下の手順を参考にしてください。

1. 以下のリンク先にアクセスする。

Rakuten Web Service サイト

2. 画面右上のアプリID発行をクリックする。

Rakuten Web ServiceにてアプリIDを発行をクリックする

3. 楽天会員のアカウントをお持ちの場合はそのまま入力。持っていない場合は新規作成をしてログインする。

Rakuten Web Serviceのログイン画面

4. 各種情報の入力をする。

アプリ名には、RakutenAPIを利用するアプリ名やウェブサイト名を入力してください。

アプリURLにはアプリやウェブサイトのURLを入力しましょう。

楽天APIのアプリID発行画面

入力が完了したら、「規約に同意して新規アプリを作成」をクリックしてください。

楽天APIのアプリID発行画面の登録

5. 以下のような画面が表示されればアプリIDの作成は完了です。表示されない場合は、画面右上のアプリ情報の確認をクリックしてください。

アプリ情報の表示画面

6. 以下の赤枠で囲った箇所の番号をメモっておいてください(後でAPIを叩くときに使用します)。

アプリ情報の表示画面のアプリID

以上で、楽天APIを使用するための準備は完了です。

楽天APIを体験する

アプリIDを取得できたところで、さっそく楽天APIをプログラムに組み込んで動作を確認したいと思う方が多いと思います。

が、動作確認をしてどんな感じのデータが取れるのかを確認するだけなら、Rakuten Web Serviceサイト内でお試し実行することができます(以下リンク先参照)。

APIテストフォーム


ここでは楽天APIの中の楽天商品検索APIを実際に使って、どのような検索結果が得られるか紹介したいと思います。


1. APIテストフォームを開きます。

楽天商品検索APIのAPIテストフォーム

2. 検索したい条件をパラメータに入力します。

今回は例として商品名に「Python」を含む商品の一覧を取得したいので、Keywordのパラメータに「Python」と入力します。

楽天商品検索APIのAPIテストフォームで検索条件を入力する

3. 「GET」をクリックすると、結果を取得することができます。

楽天商品検索APIのAPIテストフォームでの実行結果

大量にデータが取得できてしまうので、1個にフォーカスを当ててみてみると、以下のようなデータが取得できていることがわかります。

"Item": {
    "affiliateRate": 3,
    "affiliateUrl": "",
    "asurakuArea": "",
    "asurakuClosingTime": "",
    "asurakuFlag": 0,
    "availability": 1,
    "catchcopy": "【楽天ブックスならいつでも送料無料】",
    "creditCardFlag": 1,
    "endTime": "",
    "genreId": "101937",
    "giftFlag": 0,
    "imageFlag": 1,
    "itemCaption": "Bill Lubanovic 鈴木 駿 オライリー・ジャパンニュウモンパイソンスリーダイニハン ビル ルバノビック スズキ ハヤオ 発行年月:2021年03月22日 予約締切日:2021年01月27日 ページ数:800p サイズ:単行本 ISBN:9784873119328 原著第2版 第1部 Pythonの基礎(Pyの味見/データ:型、値、変数、そして名前/数値 ほか)/第2部 Pythonの実践(データの自在な操作/カレンダーとクロック/ファイルとディレクトリ ほか)/付録(初心者プログラマのためのハードウェア、ソフトウェア入門/Python3のインストール/話は変わりまして:非同期処理 ほか) データサイエンスやウェブ開発、セキュリティなど、さまざまな分野で人気を獲得してきているPython。本書は、ベストセラーの6年ぶりの改訂版で、プログラミング初級者を対象としたPythonの入門書です。プログラミングおよびPythonの基礎から、ウェブ、データベース、ネットワーク、並行処理といった応用まで、実践を見据えたPythonプログラミングをわかりやすく丁寧に説明します。Python3.9に対応し、f文字列などの新機能も追加され大幅にボリュームアップしました。Pythonの機能をひと通り網羅し、リファレンスとしても便利です。 本 パソコン・システム開発 プログラミング その他 パソコン・システム開発 その他",
    "itemCode": "book:20271780",
    "itemName": "入門Python3 第2版 [ Bill Lubanovic ]",
    "itemPrice": 4180,
    "itemUrl": "https://item.rakuten.co.jp/book/16627214/",
    "mediumImageUrls": [
        {
        "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/9328/9784873119328.jpg?_ex=128x128"
        }
    ],
    "pointRate": 1,
    "pointRateEndTime": "",
    "pointRateStartTime": "",
    "postageFlag": 0,
    "reviewAverage": 5,
    "reviewCount": 1,
    "shipOverseasArea": "",
    "shipOverseasFlag": 0,
    "shopAffiliateUrl": "",
    "shopCode": "book",
    "shopName": "楽天ブックス",
    "shopOfTheYearFlag": 0,
    "shopUrl": "https://www.rakuten.co.jp/book/",
    "smallImageUrls": [
        {
        "imageUrl": "https://thumbnail.image.rakuten.co.jp/@0_mall/book/cabinet/9328/9784873119328.jpg?_ex=64x64"
        }
    ],
    "startTime": "",
    "tagIds": [],
    "taxFlag": 0
}

このように、どんな感じのパラメータがあって、どのようなデータが取得できるのかを簡単に体験することができます。

実際には、上記で得たjsonデータをプログラムでいい感じに処理してサービスなどで使います。

実際にプログラムで使用する記事も後々書きますのでお待ちください。。

今回は以上となります。

まとめ

楽天APIを使用するにはアプリIDを取得する必要がある。
APIテストフォームで簡単に楽天APIを体験することができる。

参考文献・おすすめ文献