API連携における「APIのアクセス制限」設定の仕様と通信の挙動について
「楽楽販売」の「APIのアクセス制限」欄が空欄の場合、すべてのAPI通信は拒否されます
「楽楽販売」のAPI機能では、セキュリティを確保するための仕組み上、「管理者設定」>「セキュリティ設定」>「IPアクセス制限に関する設定」にある「APIのアクセス制限」欄に登録されたIPアドレスからのリクエストのみを許可する仕様となっております。
そのため、この欄が空欄(未設定)の状態では、通信を許可するIPアドレスが一つも存在しないとシステムが判断するため、どのIPアドレスからAPIリクエストを送信しても「403 Forbidden(アクセスが拒否されました)」というエラーが発生し、すべてのAPI通信が遮断されます。
API連携を正常に動作させるための設定手順
外部システム(RPAや自社プログラム等)からAPIを呼び出すためには、必ず送信元となるサーバーのグローバルIPアドレスを登録する必要があります。
IPアドレスの登録手順
【設定箇所】 管理者設定 > セキュリティ設定 > IPアクセス制限に関する設定
1. 管理者権限を持つユーザーで「楽楽販売」にログインします。
2. 「管理者設定」>「セキュリティ設定」>「IPアクセス制限に関する設定」を開きます。
3. 「APIのアクセス制限」欄に、APIリクエストを送信する外部システムのグローバルIPアドレスを入力します。
4. 画面下部の「確定」ボタンをクリックして保存します。
※IPアドレスを複数登録する場合は、改行区切りで入力してください。
Google Apps Script(GAS)等の動的IP環境からの接続について
Google Apps Script(GAS)のように、実行ごとに送信元IPアドレスが動的に変更される環境から直接接続を行うことは、セキュリティ上の制限により推奨しておりません。
Googleが公開しているIPアドレス範囲は非常に膨大かつ不定期に更新されるため、これらをすべて「APIのアクセス制限」に登録することは、登録上限数やシステム負荷の観点から現実的ではありません。
推奨される代替構成:
固定IPアドレスを保持できるサーバーや、固定IPからの送信に対応したiPaaS・外部連携ツールを中継(プロキシ)として挟む構成を構築してください。
その中継サーバーの固定IPアドレスを「APIのアクセス制限」欄に登録することで、セキュリティを担保した状態でAPI連携が可能となります。
関連記事
詳細な仕様や設定手順については、下記記事をご確認ください。
API連携オプション:設定方法
API連携の接続先URLや、リクエストパラメータの構成規則について詳しく解説しています。
API連携オプション:設定方法
(記事ID:3071)
「API連携オプション」の関連記事一覧
こちらの記事もあわせてご確認ください。
- Google Apps Script(GAS)からAPI接続を行う際のIPアドレス制限設定について
- CSVデータインポートAPIで登録・更新できるデータの範囲について
- CSVデータインポートAPIを利用して外部システムからデータを一括更新・登録する手順
- API連携でDBリンク項目や選択肢項目に値を指定してレコードを登録する方法
- 「楽楽販売」とGoogleカレンダー/OutlookカレンダーのAPI連携について
- 外部システムから「楽楽販売」の特定のレコード詳細画面へ直接遷移するURLを取得する方法
- API連携オプション導入による既存のインポート設定やDB設定への影響について
- 「楽楽販売」のファイル項目(PDF)をAPIで登録する方法と上限サイズについて
- CSVデータインポートAPIのリクエストBody形式(仕様)について