API連携でエラーが発生した場合の原因特定と対処手順(403・401・400エラー)
API連携時のエラーは、接続元IPアドレスの未登録(403)、APIトークンの不一致・未確定(401)、またはリクエストパラメータの記述ミス(400)が主な原因です。
返却されたレスポンス内のエラーコードをご確認ください。
「楽楽販売」のWeb API連携でエラーが発生した場合、実行側のシステムに返却されるAPIレスポンスに含まれるエラーコード(code)やメッセージ(msg)から原因を特定できます。
エラー403「アクセスが拒否されました」が出ている場合(IPアドレスの確認)
外部システム(RPAや自社プログラム等)からの通信許可設定が不足している場合に発生します。外部システムの接続元(グローバルIPアドレス)が「楽楽販売」側に登録されていないと、セキュリティ保護のため通信が遮断されます。
【設定箇所】 [管理者設定] > [セキュリティ設定]タブ > IPアクセス制限に関する設定
【対処手順】
- 「APIのアクセス制限」欄を確認します。
- APIを実行する外部システムの送信元グローバルIPアドレスが登録されているか確認します。
- 未登録の場合は、該当のIPアドレス(またはサブネット範囲)を追加し、画面下部の「確定」ボタンをクリックして保存します。
エラー401「認証エラーです」が出ている場合(APIトークンの確認)
APIトークンが正しく設定されていないか、トークン生成後に保存処理が行われていない場合に発生します。
【設定箇所】 [管理者設定] > [ユーザ設定]タブ > ユーザ管理
【対処手順】
- API連携に使用しているユーザーの「設定」画面を開きます。
- APIトークンを発行(または再発行)した後、必ず画面下部の「確定」ボタンを押して保存してください(「確定」を押さないと新しいトークンは有効化されません)。
- 確定後、ユーザー一覧でAPIトークン欄にチェックマークが付いていることを確認し、外部システム側の設定値を新しいトークンへ書き換えてください。
エラー400「パラメータが不正です」が出ている場合(リクエストJSONの確認)
送信しているリクエストパラメータ(JSON)の記述ミスや型の不一致、必須項目の不足により発生します。
【確認・対処手順】
- 大文字・小文字の区別: パラメータ名の大文字・小文字(例:
KeyIdではなくkeyId、dbSchemaIdなど)が一字一句合っているか確認します。 - 不要な空白・改行の除外: パラメータ前後に不要なスペースや改行コードが含まれていないか確認します。
- パラメータの型と必須条件: 文字列型/数値型の指定が正しく、マニュアルに記載された必須項目(
dbSchemaIdやid/keyIdなど)が含まれているか確認します。
関連記事
接続先URLやリクエストパラメータの構成ルールについては、下記マニュアルをご確認ください。
API連携オプション:設定方法
API連携の接続先URLや、リクエストパラメータの構成規則について詳しく解説しています。
API連携オプション:設定方法
(記事ID:3069)
「API連携オプションがうまくいかない」の関連記事一覧
こちらの記事もあわせてご確認ください。
- APIの過去の実行履歴(リクエスト回数)を確認・出力する方法
- CSVエクスポートAPIでメニューの複雑な絞り込み条件(複数設定)を適用してデータを取得することは可能か
- APIでインポート対象のデータベース(DB)を切り替える際の設定・確認手順
- レコード登録APIの実行時に従属項目の自動取得と任意値の指定を併用する方法・代替案
- APIで明細行を更新する際に行数が減っても余分な行が削除されない事象の解決策
- 外部システムからCSVエクスポートAPIを利用してデータ連携を行う方法・設定手順
- API連携オプション:エラー「内部エラーが発生しました。」と表示された
- API連携オプション:その他のエラー
- API連携オプション:エラー「アクセスが拒否されました。」と表示された