PR

楽天APIの新ルール:Access Key・Application ID・Affiliate IDの設定方法【2026年版】

楽天ウェブサービス
記事内に広告が含まれています。

楽天市場の商品情報をブログやWebサイトに表示するために、楽天ウェブサービスのAPIを利用している方は、APIの仕様変更に注意が必要です。

2026年7月1日版の「楽天市場商品検索API」では、Application ID(アプリID)に加えてAccess Keyも必須となっています。

一方、Affiliate ID(アフィリエイトID)は、楽天市場商品検索APIの仕様上は必須パラメータではありません。ただし、楽天アフィリエイトの成果をAPI経由の商品リンクに反映させたい場合には、Affiliate IDを設定することが重要です。

この記事では、2026年9月時点の楽天公式仕様をもとに、楽天市場商品検索APIの設定方法と、Access Key・Affiliate IDの違いを分かりやすく解説します。

楽天APIの2026年版で変わったポイント

2026年7月1日版の楽天市場商品検索APIでは、APIへのアクセスにApplication IDとAccess Keyの両方が必須となっています。

Access Keyは、リクエストヘッダーまたはクエリパラメータとして指定できます。

楽天公式のAPI仕様では、以下のように定義されています。

項目パラメータ必須役割
アプリIDapplicationId必須APIアプリを識別するID
Access KeyaccessKey必須APIアクセスに使用するキー
Affiliate IDaffiliateId任意アフィリエイト用ID
レスポンス形式format任意JSONまたはXML
フォーマットバージョンformatVersion任意APIレスポンス形式を指定

楽天公式仕様では、applicationId と accessKey はセットで必須です。一方、affiliateId は必須パラメータには指定されていません。

1. Application IDとAccess Keyを用意する

楽天ウェブサービスを利用するには、APIアプリを登録してApplication IDとAccess Keyを取得します。

既存のアプリを利用している場合は、まず現在のアプリ設定と発行されているAccess Keyを確認しましょう。

Access Keyはどこで使う?

Access Keyのパラメータ名は、accessKey です。

API仕様では、Access Keyはリクエストヘッダーまたはクエリパラメータで指定できます。

2. APIのURLを2026年7月1日版に変更する

楽天市場商品検索APIの2026年7月1日版では、リクエストURLは以下の形式です。

https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701

ポイントは次の3つです。

  • ドメインが openapi.rakuten.co.jp
  • APIは IchibaItem/Search
  • バージョンが 20260701

楽天公式のAPIテストフォームでも、2026年7月1日版の商品検索APIとして、このURLが使用されています。

3. Access Keyをパラメータとして指定する

もっとも分かりやすい方法は、Access Keyをクエリパラメータとして指定する方法です。

例えば、基本的なリクエストは以下のようになります。

https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701?applicationId=[アプリID]&accessKey=[Access Key]&keyword=%E7%A6%8F%E8%A2%8B

実際に使用するときは、[アプリID]と[Access Key]を自分の値に置き換えます。

Access KeyをURLに含める方法のほか、リクエストヘッダーに指定する方法も楽天公式で案内されています。

4. Affiliate IDは「必須キー」とは別に考える

ここは特に注意したいポイントです。

affiliateId は、楽天市場商品検索APIの入力パラメータとして用意されていますが、公式仕様上は必須ではありません。

そのため、「Application ID・Access Key・Affiliate IDの3つがすべて必須」と説明するのは正確ではありません。

楽天ウェブサービスの公式ガイドでは、Affiliate IDは開発者ごとに1つ発行され、複数のアプリで同じAffiliate IDを利用する仕組みとされています。

Affiliate IDを設定する場合

Affiliate IDを指定する場合は、affiliateId=[Affiliate ID] という形で追加します。

例えば、

https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701?applicationId=[アプリID]&accessKey=[Access Key]&affiliateId=[Affiliate ID]&keyword=%E7%A6%8F%E8%A2%8B

のようになります。

楽天アフィリエイトの成果を目的としてAPIを利用している場合は、アフィリエイトリンクとして利用するために設定を確認しておきましょう。

5. キーワードやソート値は個別にURLエンコードする

楽天公式では、keyword と sort の値について、UTF-8形式でURLエンコードするよう案内されています。

重要なのは、リクエストURL全体をエンコードするのではなく、各パラメータの値を個別にエンコードすることです。

例えば、「福袋」を検索する場合は %E7%A6%8F%E8%A2%8B となります。

また、+itemPrice を指定する場合は %2BitemPrice とします。

楽天公式の例でも、以下のような指定になっています。

  • keyword=%E7%A6%8F%E8%A2%8B
  • sort=%2BitemPrice

6. formatVersion=2を利用する場合

楽天市場商品検索APIには、レスポンス形式を指定するformatVersionがあります。

formatVersion=2を指定すると、JSONレスポンスの構造が改善され、データ構成が変わります。

そのため、既存プログラムを新しい形式に対応させる場合は、これまでのレスポンス階層をそのまま使わず、変更後のデータ構造に合わせて商品名や価格などを取得するプログラムの処理を確認・修正するようにしてください。

7. 完成したリクエストURLの例

例えば、

  • Application ID
  • Access Key
  • Affiliate ID
  • 「福袋」というキーワード
  • 価格の安い順
  • formatVersion=2

を指定する場合は、次のような構成になります。

https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701?applicationId=[APPLICATION_ID]&accessKey=[ACCESS_KEY]&affiliateId=[AFFILIATE_ID]&keyword=%E7%A6%8F%E8%A2%8B&sort=%2BitemPrice&formatVersion=2

実際のプログラムでは、IDやキーを直接コードに書き込むのではなく、設定ファイルや環境変数などで管理する方法も検討してください。

8. 商品が表示されないときのチェックリスト

確認項目確認する内容
APIドメインopenapi.rakuten.co.jp を使用しているか
APIパス/ichibams/api/IchibaItem/Search/20260701 になっているか
Application IDapplicationId を指定しているか
Access KeyaccessKey を指定しているか
Access Keyの場所ヘッダーまたはクエリパラメータで正しく指定しているか
Affiliate IDアフィリエイト用として必要に応じて affiliateId を確認しているか
キーワードUTF-8でURLエンコードしているか
ソート+ など特殊文字をURLエンコードしているか
formatVersion変更した場合、プログラム側のレスポンス構造・取得処理も確認したか
URL実際のリクエストを1行で送信しているか

9. 「Access Key」と「Affiliate ID」は役割が違う

両方ともIDのように見えるため、混同しやすいですが、役割は異なります。

  • Access Key
    APIアクセスに使用するキーです。2026年7月1日版の楽天市場商品検索APIでは、Application IDとともに必須となっています。
  • Affiliate ID
    楽天アフィリエイトに関連するIDです。API仕様では任意パラメータとなっており、Access Keyの代わりになるものではありません。

つまり、

Application ID + Access Key ⇒ APIリクエストに必要な情報

Affiliate ID ⇒ アフィリエイト関連の設定

は分けて考えると分かりやすくなります。

10. 2026年版で既存プログラムを確認するポイント

以前の楽天APIを利用している場合は、単純にURLだけを書き換えるのではなく、次の項目を確認しましょう。

  • URL:旧バージョンから https://openapi.rakuten.co.jp/ichibams/api/IchibaItem/Search/20260701 へ変更します。
  • Access Key:applicationIdだけでアクセスする古いコードの場合は、accessKeyの追加が必要です。
  • Affiliate ID:アフィリエイトを利用している場合は、affiliateIdが正しく設定されているか確認します。
  • JSONの読み取り:formatVersion=2を使用する場合は、APIから返されるJSONの構造に合わせて、商品名・価格・URLなどを取得するプログラムを確認します。

まとめ

2026年7月1日版の楽天市場商品検索APIでは、Application IDとAccess Keyが必須になっています。

一方、Affiliate IDはAPI仕様上の必須パラメータではないため、「3つすべてが必須」と考えるのではなく、それぞれの役割を分けて設定することが重要です。

特に既存の楽天APIプログラムを利用している場合は、次の項目を確認しておきましょう。

  • APIのバージョンが 20260701 になっているか
  • openapi.rakuten.co.jp を利用しているか
  • applicationId を指定しているか
  • accessKey を指定しているか
  • 必要に応じて affiliateId を確認・設定しているか
  • keywordやsortの値を個別にURLエンコードしているか
  • formatVersion=2に変更した場合、JSONの読み取り処理も変更しているか

楽天公式の仕様は今後も更新される可能性があるため、APIを利用する際は最新の公式ドキュメントも確認することをおすすめします。

参考:楽天ウェブサービス公式(楽天市場商品検索API 2026年7月1日版 / 楽天ウェブサービス利用ガイド)

コメント

タイトルとURLをコピーしました