SFTP会員一括登録
概要
SFTP会員一括登録は、CSVファイルをアップロードすることで複数の会員情報を一括で登録・変更・削除できる機能です。
利用シーン:
- 既存システムから移行時に大量の会員データを一括登録したい
- 定期的に会員情報の更新を自動化したい
- カード有効期限の一括更新を効率的に実施したい
特徴:
- 最大1万件まで1ファイルで処理可能
- 新規登録・変更・削除の3つの処理区分に対応
- 会員登録時に自動的にカード有効性チェックを実施
- 処理結果は約45分で返却(1万件の場合)
SFTP会員一括登録を利用するには、別途SFTPサーバー利用の契約が必要です。
SFTPファイル連携の流れで基本的な接続手順をご確認ください。
利用の流れ
SFTP会員一括登録は、以下の流れで処理を行います。
処理ステップ
ステップ1:ファイルアップロード
- 規定のファイル命名規則に従ってCSVファイルを作成
- CSVファイルをSFTPサーバーにアップロード
- OKファイル(空ファイル)をアップロード
- OKファイルは処理開始の合図として機能します
- CSVファイルと同名に
.ok拡張子を付与
ステップ2:バッチ処理
当サービスが自動的に以下を実行します:
- ファイルを検知して取得
- 会員情報の登録・変更・削除処理
- カード有効性チェックの実施
- 処理結果ファイルの生成
ステップ3:結果ファイル取得
- SFTPサーバーから結果ファイルとOKファイルを取得
- 結果内容を確認(エラーがあれば対応)
- 必ず結果ファイルとOKファイルをサーバーから削除
- 削除しないと次のファイルをアップロードできません
OKファイルは、CSVファイルのアップロードが完了したことを示す合図です。大容量ファイルのアップロード中に処理が開始されるのを防ぎます。
制約事項
実装を開始する前に、以下の制約事項を必ずご確認ください。
処理件数の上限
1ファイルで処理可能なレコード数は最大1万件です。
1万件を超える場合の対応
それ以上の件数をアップロードする場合は、営業担当までご相談ください。
同時アップロードの制限
一度にアップロード可能なファイルは1ファイル(データファイルとOKファイルの1ペア)のみです。
複数ファイルを処理する場合
以下の手順で順次処理してください:
- 1つ目のファイルをアップロード(データファイル + OKファイル)
- 結果ファイルが返却されるまで待機
- 結果ファイルを取得して内容を確認
- 取得した結果ファイルとOKファイルをサーバーから削除
- 次のファイルをアップロード(手順1に戻る)
結果ファイルとOKファイルを削除しないと、次のファイル処理が開始できません。
ファイル名の制約
同一ファイル名は1度のみアップロード可能です。
再アップロードが必要な場合は、ファイル名の連番部分を変更してください。
処理時間の目安
標準的な処理時間
SFTPに配置してから返却ファイルを配置するまで、1万件で約45分です。
- 件数が少ない場合はより短時間で処理されます
- 時間帯やシステム負荷により前後する場合があります
ファイル命名規則
- アップロードファイル
- 結果ファイル
アップロードファイル
memberimport + ショップID + 処理日YYYYMMDD + 連番3桁 + .csv
OKファイル
(アップロードファイル名) + .ok
アップロードファイル名に.okを付与します。
ファイルの中身は空です。
例:ショップID
0009999099999が2024年12月31日にファイルを作成
memberimport000999909999920241231001.csv
memberimport000999909999920241231001.csv.ok
- 同一ファイル名は1度のみアップロード可能です
- 再アップロードが必要な場合は、連番部分を変更してください
ファイル仕様
基本フォーマット
- 区切り文字:
,(カンマ) - 項目の括り:全項目を
"(ダブルクォート)で括る - 改行コード:CRLF推奨(LFでアップロードした場合もCRLFで返却されます)
- アップロードファイル
- 結果ファイル
アップロードファイル仕様
| No | 項目名 | 桁数 | 必須 | 説明 |
|---|---|---|---|---|
| 1 | サイトID | 13 | ✔ | 一括会員情報登録を実施するサイトのID(半角英数字) 弊社から指定する値をセットしてください。 |
| 2 | 会員ID | 60 | ✔ | 会員を特定するユニークなID 設定可能な文字:半角英数字 + 半角記号( - @ _ .) |
| 3 | 会員名 | 255 | 会員の名前 | |
| 4 | 区分 | 1 | ✔ | 行う処理を識別するコード0:新規1:変更2:削除 |
| 5 | カード番号 | 16 | ✔* | カード番号(半角数字) 区分が 0(新規)の場合必須※1 |
| 6 | 有効期限 | 4 | ✔ | カード有効期限(半角数字)YYMM形式 |
| 7 | カード名義人 | 50 | カード名義人 | |
| 8 | 有効性チェック有無 | 1 | ✔ | 0を設定してください。一括登録時には有効性チェックは必須です。※2 |
| 9 | チェック実施日 | 8 | ""を設定してください。※2 | |
| 10 | 処理結果 | - | - | 出力用項目 |
| 11 | カード登録結果 | - | - | 出力用項目 |
| 12 | 仕向先結果 | - | - | 出力用項目 |
- ✔:必須
- ✔*:条件により必須
- 空白:省略可能
- -:出力時
※1:区分が1(変更)の場合の挙動
区分を1(変更)に設定した場合、項目によって挙動が異なります。
| 項目 | 設定あり | 設定なし |
|---|---|---|
| 会員名 | 設定値が入る | 空になる |
| カード番号 | 設定値が入る | 変更されない |
| 有効期限(必須) | 設定値が入る | 設定値が入る |
| 名義人 | 設定値が入る | 空になる |
- 有効期限のみ変更する際は、必須項目に加えて会員名、カード名義人も設定してください。
※2:有効性チェックは必須です
SFTP会員一括登録では、設定値に関わらず必ず有効性チェックが実行されます。
- 「有効性チェック有無」と「チェック実施日」の項目は、一括会員登録時には無視されます
- これらに
0や""以外の値を設定しても、その設定値に応じた動作は行われません - 形式上、「有効性チェック有無」には
0、「チェック実施日」には""を設定してください
- これらに
- 有効性チェックを回避したい場合(サービス移行時など)は、特殊対応が必要です
- 営業担当までご相談ください
登録連番(物理)の扱い
- カード番号ありで変更:登録連番(物理)はカウントアップされます
- カード番号なしで変更:登録連番(物理)は変更されません
結果ファイル仕様
| No | 項目名 | 桁数 | 説明 |
|---|---|---|---|
| 1 | サイトID | 13 | アップロード時に指定した値 |
| 2 | 会員ID | 60 | アップロード時に指定した値 |
| 3 | 会員名 | 255 | アップロード時に指定した値 |
| 4 | 区分 | 1 | アップロード時に指定した値 |
| 5 | カード番号 | 16 | ダウンロードファイルでは伏字(****************) |
| 6 | 有効期限 | 4 | ダウンロードファイルでは伏字(****) |
| 7 | カード名義人 | 50 | アップロード時に指定した値 |
| 8 | 有効性チェック有無 | 1 | アップロード時に指定した値 |
| 9 | チェック実施日 | 8 | アップロード時に指定した値 |
| 10 | 処理結果 | 1 | 0:登録OK1:フォーマットエラー2:会員ID重複エラー3:変更/削除時会員IDなしエラー4:データ不整合9:カード会社与信エラー |
| 11 | 登録結果 | 9 | 000000000:登録OK上記以外:登録NG(エラーコードが入ります) |
| 12 | 仕向先結果 | 7 | カード有効性チェックを送信したカード会社コード ※区分 2(削除)の場合は"" |
結果ファイルの例
正常の場合
"mst0000099999","id00001","会員名1","0","****************","****","KAIIN1","0","","0","000000000","2a99663"
会員ID重複エラーの場合
"mst0000099999","id00002","会員名2","0","****************","****","KAIIN2","0","","2","",""
カード会社でエラーとなった場合
"mst0000099999","id00003","会員名3","0","****************","****","KAIIN3","0","","9","42G650000",""
フォーマットエラーの場合
"mst0000099999","id00003","会員名3","0","****************","****","KAIIN3","0","","1","E01180011",""
登録NGの場合、エラーコードが入ります。エラー内容については、別紙「エラーコード表」をご参照ください。
その他の注意事項
複数枚カード登録済み会員の制限
1つの会員に対して複数枚カードが登録されている場合は、更新できません。
データ0件ファイルの扱い
データ0件のファイルが配置された場合、空のファイルを返却します。