APIでインポート対象のデータベース(DB)を切り替える際の設定・確認手順

APIで実行対象のデータベースを変更する際は、IDの書き換えだけでなく「インポート設定の列構成」の再確認が必要です。

API連携(CSVデータインポートAPIやCSVファイルインポートAPIなど)において、接続先のデータベースを切り替える場合、プログラム上の「データベースID(dbSchemaId)」や「インポート設定ID(importId)」を書き換えるだけでは不十分なケースがあります。

システムの正確性を保つためのセキュリティ制限や、データベースごとのインポートルールの違いにより、処理が失敗したり、API上は正常終了しているのにデータが登録されなかったりする事象が発生します。

主な事象

過去の問い合わせデータやFAQでは、データベースの切り替え時に以下のようなトラブルが報告されています。

  • APIを実行すると「403:アクセスが拒否されました」というエラーが返ってくる。
  • APIのレスポンスは「complete(成功)」となっているのに、対象のデータベースを確認してもレコードが1件も登録されていない。
  • 手動でのインポートは成功するのに、API経由で同じIDを指定するとエラー(400:パラメータが不正です)になる。

これらのトラブルは、主に「接続許可設定」や「パラメータの記述ルール」の見落としが原因です。以下の確認・対処手順に沿って設定を見直してください。


エラーを解消するための確認・対処手順

1. インポート設定の「列の並び順」と「項目数」がCSVファイルと一致しているか確認する

API上は正常終了しているのにデータが登録されない場合、指定した「インポート設定ID(importId)」の内容が、送信しているCSVファイルの構造と合致していない可能性があります。手動インポートと異なり、APIでは「設定とファイルの不一致」が原因で全行がスキップされることがあります。

【確認箇所】 DB設定 > 機能設定 > インポート一覧 > 該当設定の「項目設定」

【確認・対処手順】
1. 切り替え先のデータベースに作成した「インポート設定」を開きます。
2. 「項目設定」画面で、設定されている項目の数と並び順が、APIで送信するCSVファイルの列構成と完全に一致しているか確認してください。
3. 不要な列がある場合は「スキップ項目」を配置し、不足している場合は項目を追加してください。項目数や並び順が1つでもズレていると、入力検証エラーにより登録がスキップされます。

2. JSONパラメータの「大文字・小文字」が正確か再チェックする

APIリクエスト時に送信するJSONパラメータ(dbSchemaId, importId, keyIdなど)は、大文字と小文字を厳密に区別します。プログラムをコピー&ペーストして作成した際に、一部の文字が異なっていると「パラメータが不正です(400エラー)」となります。

【確認・対処手順】
1. リクエストボディのJSONを確認します。
2. 例えば「KeyId」と記述している場合、正しくは「keyId」です。マニュアルに記載された正確なパラメータ名(例:dbSchemaId, importId)と一字一句違わないか、スペルミスがないかを確認してください。

3. APIトークンを発行したユーザーの「全体権限」と「DBアクセス権」を確認する

API実行に使用している「APIトークン」に紐づく実行ユーザーが、新しく指定したデータベースに対して適切な権限を持っていない場合、インポート設定(importId)を正しくロードできず処理が失敗します。

【確認箇所】 管理者設定 > ユーザー設定 > ユーザー管理 > [対象ユーザーの「設定」および「アクセス権」]

  • 【必要な機能権限】:
    ユーザーの基本設定にて、全体権限の「DB設定」権限にチェックが入っているか確認してください。
  • 【必要なデータベースアクセス権】:
    対象のユーザー(または所属するユーザーグループ)に対し、接続先のデータベースの「参照」アクセス権および「管理」アクセス権が100%付与されているか確認してください。
    特に「管理」アクセス権がないデータベースに対しては、APIによるインポート設定の呼び出し、および失敗時のエラーログ(エラーデータ.csv)のダウンロードがシステム仕様上制限され、アクセス拒否(403)となります。

関連マニュアル

詳細な仕様の違いや作成手順については、下記記事をご確認ください。

API連携の接続先URLやパラメータの詳細に関するマニュアル

CSVエクスポートやインポートAPIの正式なエンドポイントURL、リクエスト形式の具体例について解説しています。
API連携オプション:設定方法

インポート設定の項目紐付けに関するマニュアル

CSVファイルの列とデータベース項目を正しく対応させるための「項目設定」の手順や、スキップ項目の活用方法について記載しています。
インポート一覧:項目設定

API連携でエラーが発生した際のトラブルシューティング

403エラー(アクセス拒否)や400エラー(パラメータ不正)の具体的な原因とチェックリストをまとめています。
API連携オプション:エラー「アクセスが拒否されました。」と表示された

(記事ID:2924)