インポートAPIの実行

URL

次のURLにアクセスし、カスタムデータベースへデータをインポートするAPIを呼び出します。

URL http://[IPアドレスまたはホスト名]:[ポート番号]/XFV20/api/userdb/import/data
HTTPメソッド POST
imggotop ページTOPへ

APIトークンによる認証

APIへの不正アクセスを防止するため、リソースへアクセスするためにはAPIトークンによる認証が必須となります。
APIトークンは[インポートAPI設定]画面で事前に生成し、リクエストヘッダーまたはパラメーターに指定する必要があります。
APIトークンの生成については[インポートAPI設定]を参照ください。

APIへアクセスする際にリクエストヘッダーまたはパラメーターへ生成したAPIトークンを指定します。

種別 名前
ヘッダー X-CWF-API-Token
パラメーター api_token 
http://[IPアドレスまたはホスト名]:[ポート番号]/XFV20/api/userdb/import/data?api_token=ZU3fHY0LuH0izt2ytqisp3lcKzKfv8a2XDLGK80t

ヒント

  • APIトークンは自動生成のほか、任意の英数字を使用して指定することもできます。
  • APIトークンをヘッダーまたはパラメーターに指定していない場合や正しくない場合、 エラーレスポンス が返されます。
  • ヘッダーとパラメーターを同時に指定した場合はパラメーターの値が優先されます。
imggotop ページTOPへ

文字コードとフォーマット

文字コードはUTF-8を使用し、JSONフォーマットでデータをやり取りします。文字コードやフォーマットを変更することはできません。

imggotop ページTOPへ

送信パラメーター定義

送信パラメーターには次の項目を指定します。

名前 必須 指定可能な値 初期値 説明
table_name ○ ― ― インポート対象のテーブル名を指定します。大文字、小文字は区別しません。
import_data ○ Base64 ― インポートするCSVファイルをBase64フォーマットに変換した文字列を指定します。
encoding ○ MS932、UTF-8 ― インポートするCSVファイルのエンコードを指定します。
replace ― true、false false データの更新方法を指定します。
trueを指定した場合、既存データをすべて削除し、CSVファイルのデータをインポートします。
falseを指定した場合、既存データと主キー列のデータの組み合わせが重複しないデータのみインポートします。既存データは上書きされません。

ヒント

テーブル「customer_master」にエンコードがUTF-8のCSVファイルをインポートし、既存のデータを削除してすべて置き換える場合、パラメーターは次のように指定します。

{
    "table_name":"customer_master",
    "import_data":"Y3VzdG9tZXJfY29kZSxjdXN0b21lcl9uYW1lLGFkZHJlc3MsdGVsZXBob25lX251bWJlcixpbmR1c3RyaWVzDQpBMDAwNSzjg4bjg4Pjgq/mg4XloLHmoKrlvI/kvJrnpL4s5p2x5Lqs6YO9LDAzLTg3NjUtNDMyMSzmg4XloLHjg7vpgJrkv6Hmpa0NCkEwMDA2LOODhuODg+OCr+W7uuioreagquW8j+S8muekviznpZ7lpYjlt53nnIwsMDQ1LTc2NS00MzIxLOW7uuiorealrQ0KQTAwMDcs44OG44OD44Kv6aOf5ZOB5qCq5byP5Lya56S+LOWNg+iRieecjCwwNDMtNzY1LTQzMjEs6KO96YCg5qWt",
    "encoding":"UTF-8",
    "replace":"true"
}
imggotop ページTOPへ

受信パラメーター定義

受信パラメーターには次の項目が設定されます。

項目名 データ型 説明
error_lines 配列 エラーが発生しインポートされなかった行のエラー内容が設定されます。
エラーがなく、すべての行がインポートされた場合、空の配列が設定されます。
　　line 整数 エラーが発生しインポートされなかったデータの行番号が設定されます。
APIトークンの誤りなどによりすべての行がインポートされなかった場合、0が設定されます。
　　message 文字列 エラーメッセージが設定されます。
設定されるメッセージについては[エラーメッセージ]を参照ください。

ヒント

エラーが発生せずすべての行がインポートされた場合、受信パラメーターに次のようになります。

{
    "error_lines": [
    ]
}
imggotop ページTOPへ

エラーメッセージ

[APIトークンによる認証]や[送信パラメーター]に問題がある場合、次のエラーメッセージが返されます。
説明や対処方法を参考にアクセス内容が正しいことを確認してください。

ヒント

APIトークンに誤りがあり認証が失敗した場合、レスポンスは次のようになります。

{
    "error_lines": [
        {
            "line": 0,
            "message": "API token invalid."
        }
    ]
}
HTTPステータス エラーメッセージ 対処方法
401 API token not found. APIトークンが登録されていません。カスタムデータベースのインポートAPI設定画面からAPIトークンを登録してください。
401 API token required. APIトークンが指定されていません。カスタムデータベースのインポートAPI設定画面にて登録したAPIトークンをヘッダーまたはパラメーターに指定してください。
401 API token invalid. APIトークンが正しくありません。カスタムデータベースのインポートAPI設定画面にて登録したAPIトークンをヘッダーまたはパラメーターに指定してください。
400 table_name is empty. table_nameが空です。table_nameを指定してください。
400 table_name is invalid. table_nameに指定したテーブルがカスタムデータベースに存在しません。正しいtable_nameを指定してください。
400 import_data is empty. import_dataが空です。import_dataを指定してください。
400 Base64 format error. Base64フォーマットのデータの解析に失敗しました。インポートするCSVファイルのBase64フォーマット変換を確認してください。
400 encoding is empty. encodingが空です。encodingを指定してください。
400 encoding invalid. encodingが正しくありません。MS932またはUTF-8を指定してください。
500 Unknown error. データベースエラーなど、予期せぬエラーが発生しました。サポート窓口までお問い合わせください。

ヒント

上記エラーメッセージに加えて補足情報を出力する場合があります。

imggotop ページTOPへ