「楽楽販売」のSSLクライアント認証環境下におけるAPI連携は、プログラム側で証明書を付加することで実行可能です
SSLクライアント認証オプションを導入し「通常URLへのアクセス制限」を有効にしている環境では、セキュリティの仕組み上、証明書を必要とする「SSL認証URL」経由での通信が必須となります。
API連携においても、外部システム(RPAや自社プログラム等)からリクエストを送信する際、プログラム側でSSLクライアント証明書を読み込み、通信に付与する設定を行うことで、正常に認証を通過してデータ連携を行うことが可能です。
※なお、API連携の設定自体(エンドポイントURLやリクエストパラメータの指定方法など)は、SSLクライアント認証の有無に関わらず共通です。
API連携プログラムへの証明書設定手順
外部システムから「楽楽販売」へAPIリクエストを送信する際、プログラム内で証明書ファイルを指定する必要があります。以下は、Java等のプログラムで証明書を付与して接続するための一般的な設定例です。
■ 証明書ファイルの準備とプログラムへの組み込み(Java例)
管理画面からダウンロードした証明書ファイルと、取得時に発行されたパスワードをプログラム内で指定します。
【設定コード例(Java)】final String P12FILE = "証明書のファイルパス";final char[] PASSWORD = "証明書のパスワード".toCharArray();
※「証明書のファイルパス」には、ファイルを配置したディレクトリパスとファイル名(例:C:\cert\xxx.p12)を指定してください。
※証明書ファイルは、管理者が「[管理者設定] > [セキュリティ設定] > SSLクライアント認証に関する設定」からダウンロードしたものを使用します。
API連携時の注意点
SSLクライアント認証環境下でAPI連携を行う際は、以下の点にご注意ください。
- API側(楽楽販売側)での特別な設定は不要:
楽楽販売の管理画面上で、API用に特別な証明書設定を行う必要はありません。あくまで「接続する外部プログラム側」で証明書を読み込ませる対応となります。 - IPアドレス制限の登録が必須:
SSLクライアント認証を利用している場合でも、API連携を行う際は接続元となる外部システムのグローバルIPアドレスを「[管理者設定] > [セキュリティ設定] > IPアクセス制限に関する設定 > APIのアクセス制限」へ登録することが必須となります(IP制限は免除されません)。 - SSL認証URLの指定:
通常URLへのアクセス制限を有効にしている場合、APIのエンドポイントURLにはSSL認証用のURL(https://hnsslXXXXX.rakurakuhanbai.jp/...など)を指定してください。
関連記事
詳細な設定手順や仕様については、下記マニュアルをご確認ください。
SSLクライアント認証サービスオプション:設定方法
証明書のダウンロード手順や、パソコンへのインストール方法について詳しく解説しています。
SSLクライアント認証サービスオプション:設定方法
API連携オプション:設定方法
外部システムから「楽楽販売」へリクエストを送信する際の認証方法や、リクエストパラメータの仕様について解説しています。
API連携オプション:設定方法
(記事ID:3032)
「その他オプション」の関連記事一覧
こちらの記事もあわせてご確認ください。
- 「メールボックスオプション」によるインポートの制限とAPI連携との違いについて
- SSLクライアント証明書の秘密鍵をエクスポート不可としてインストールする方法
- 「/sso/off」URLでSSLクライアント認証を回避・スキップする方法
- SSLクライアント認証のログ記録仕様と確認可能な項目について
- バックアップ環境へログインするためのIDとパスワードの確認・再設定方法
- IPアドレス制限オプションにおける「X-Forwarded-For」ヘッダの利用有無と接続判定の仕組み
- 電子帳簿保存庫における項目表示・非表示設定およびCSV出力時の項目制御について
- SSLクライアント証明書のインストール時に「発行者を証明できません」等の警告メッセージが表示された場合の対処方法
- スマートフォンからSSLクライアント証明書をダウンロードするための直接のパスやQRコードを表示する方法はあるか